Settings for file types More...

Inheritance diagram for TRIM.SDK.FileTypesUserOptions:

Public Member Functions
	FileTypesUserOptions (Database inDatabase)
	Constructor for the FileTypesUserOptions option set. More...

ContentIndexDocumentStatus	GetContentIndexStatus (string fileTypeExtension, long fileSize)

bool	IsFileTypeARendition (string fileTypeExtension)
	indicates if the nominated file type extension is considered a likely rendition (these may be excluded from queue processing) More...

bool	DisableEstoreCompression (string fileTypeExtension)
	indicates if this file type is considered to be a compressed format and therefore does not need to be further compressed when storing in the document store. More...

bool	IsSuitableForOCR (string fileTypeExtension)

Public Member Functions inherited from TRIM.SDK.TrimUserOptionSet
	TrimUserOptionSet (Database db, UserOptionSetIds setId)
	Base constructor, constructs a TRIM user option set of the specified option set type. More...

void	Save ()
	Permanently commits all changes made to this option set. More...

void	LoadFromGlobalSetting ()
	Load the administrators "global settings" for this option set More...

void	SaveAsGlobalSetting ()
	Save this set as the "global setting" for this option set More...

Public Member Functions inherited from TRIM.SDK.TrimPropertySet
TrimIcon	GetPropertyIcon (PropertyIds propertyId)
	Gets the icon value associated the a property of this object. More...

TrimMainObject	GetPropertyTrimObject (PropertyIds dnPropId)

string	GetPropertyString (PropertyIds dnPropId)

int	GetPropertyLong (PropertyIds dnPropId)

long	GetPropertyLong64 (PropertyIds dnPropId)

bool	GetPropertyBool (PropertyIds dnPropId)

TrimDateTime	GetPropertyDate (PropertyIds dnPropId)

TrimDecimal	GetPropertyDecimal (PropertyIds dnPropId)

TrimCurrency	GetPropertyCurrency (PropertyIds dnPropId)

TrimURI	GetPropertyUri (PropertyIds dnPropId)

bool	SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)

bool	SetPropertyString (PropertyIds dnPropId, string newValue)

bool	SetPropertyLong (PropertyIds dnPropId, int newValue)

bool	SetPropertyLong64 (PropertyIds dnPropId, long newValue)

bool	SetPropertyBool (PropertyIds dnPropId, bool newValue)

bool	SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)

bool	SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)

bool	SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)

bool	SetPropertyDouble (PropertyIds dnPropId, double newValue)

bool	SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)

bool	ClearProperty (PropertyIds dnPropId)

object	GetProperty (PropertyIds propId)

bool	SetProperty (PropertyIds propId, object newValue)

string	GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
	Gets a string representation of a property value in a format appropriate for a specific use. More...

bool	IsMandatory (PropertyIds propertyId)
	Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...

bool	VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
	Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...

bool	CanModifyProperty (PropertyIds propertyId)
	Indicates whether the current user has the permission to modify the specified property. More...

Properties
StringArray?	SuppressRenderingList `[get]`
	Gets a status enum indicating if a file with the specified extension should have it's content indexed within the content search engine. Note that you should also check to see if the record type also excludes content indexing. Gets a list of file type extensions that should not be rendered to PDF or TIFF More...

StringArray?	BlockedFileTypesList `[get]`
	Gets a list of file type extensions that have been deemed unsuitable for storing in Content Manager by the system administrator. More...

Properties inherited from TRIM.SDK.TrimUserOptionSet
UserOptionSetIds	OptionSetType `[get]`

bool	IsReadOnly `[get]`
	Gets a BaseObjectTypes enum value indicating the type of this object. Gets a boolean parameter indicating if this option set has been locked down and is therefore unable to be modified. More...

Properties inherited from TRIM.SDK.TrimPropertySet
string	ErrorMessage `[get]`
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...

TrimException	Error `[get]`
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Database	Database `[get]`
	Gets the TRIM Database object in which this object resides. All TRIM objects live within a particular TRIM database and cannot be created without one. More...

virtual string	Caption `[get]`
	Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...

virtual TrimIcon	Icon `[get]`
	Gets the icon value associated this TrimPropertySet. More...

bool	IsModified `[get]`
	Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...

Detailed Description

Settings for file types

Constructor & Destructor Documentation

◆ FileTypesUserOptions()

TRIM.SDK.FileTypesUserOptions.FileTypesUserOptions ( Database inDatabase )

Constructor for the FileTypesUserOptions option set.

Member Function Documentation

◆ DisableEstoreCompression()

bool TRIM.SDK.FileTypesUserOptions.DisableEstoreCompression ( string fileTypeExtension )

indicates if this file type is considered to be a compressed format and therefore does not need to be further compressed when storing in the document store.

◆ GetContentIndexStatus()

ContentIndexDocumentStatus TRIM.SDK.FileTypesUserOptions.GetContentIndexStatus	(	string	fileTypeExtension,
		long	fileSize
	)

◆ IsFileTypeARendition()

bool TRIM.SDK.FileTypesUserOptions.IsFileTypeARendition ( string fileTypeExtension )

indicates if the nominated file type extension is considered a likely rendition (these may be excluded from queue processing)

◆ IsSuitableForOCR()

bool TRIM.SDK.FileTypesUserOptions.IsSuitableForOCR ( string fileTypeExtension )

Property Documentation

◆ BlockedFileTypesList

StringArray? TRIM.SDK.FileTypesUserOptions.BlockedFileTypesList

get

Gets a list of file type extensions that have been deemed unsuitable for storing in Content Manager by the system administrator.

◆ SuppressRenderingList

StringArray? TRIM.SDK.FileTypesUserOptions.SuppressRenderingList

get

Gets a status enum indicating if a file with the specified extension should have it's content indexed within the content search engine. Note that you should also check to see if the record type also excludes content indexing. Gets a list of file type extensions that should not be rendered to PDF or TIFF

Public Member Functions

Properties