The RecRendition object represents one of a Record's electronic attachments. It is therefore only available if the Record has an Electronic Document associated with it More...

Inheritance diagram for TRIM.SDK.RecordRendition:

Public Member Functions
void	SetNotes (string newValue, NotesUpdateType TypeOfNotesUpdate)
	Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them. More...

void	SetDocument (string fromFileName)
	Set the document associated with this Trim object as a copy of the supplied file name More...

void	LoadDocumentIntoClientCache ()
	Loads the document associated with this object into the client document cache, if one is available. More...

string	GetDocumentPathInClientCache (Events logAccessAs)
	Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type. More...

string	GetDocumentPathInWGSCache (Events logAccessAs)

ExtractDocument	GetExtractDocument ()

string	Extract (string outputDocumentName, bool setDocumentAsReadOnly)
	Extracts this Rendition to the file system location specified in the 'OutputDocumentName' parameter. If 'TEMP' is specified, the rendition will be extracted to the TEMP directory for the machine and a file name will be generated. Returns a string containing the filename of the extracted document. More...

void	TransferStorageInPlace (ElectronicStore newDocumentStore, string NewDocumentStoreId)
	Transfers the electronic document attached to this rendition from its current storage location to a new electronic store at the specified location More...

Public Member Functions inherited from TRIM.SDK.TrimChildObject
void	Delete ()
	Permanently removes this object and all its associated child objects from the database. More...

Public Member Functions inherited from TRIM.SDK.TrimObject
bool	IsMandatory (FieldDefinition field)
	Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...

bool	IsValidFor (int purpose)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...

bool	IsValidFor (int purpose, TrimMainObject purposeExtraObject)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...

bool	IsValidFor (int purpose, int purposeExtraEnumValue)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...

bool	HasPermission (GenericPermissions prm)
	Checks to see if the currently logged in user has permission to perform the generic action on this object More...

bool	HasPropertyPermission (GenericPermissions prm, PropertyIds propId)
	Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object 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
TrimDateTime	AddedOn `[get]`
	Gets the date this rendition was added to the parent record. More...

long	Bytes `[get]`
	Gets an integer containing the size (in bytes) of this rendition document. More...

Location?	CheckedInBy `[get]`
	Gets a location object that represents the person who checked in this rendition. More...

TrimDateTime	CheckedInOn `[get]`
	Gets the date on which this rendition was checked in. More...

int	ConfidenceLevel `[get, set]`
	Gets or sets a number indicating the confidence level associated with the OCR pattern matching process (1-100), 0 = unknown. More...

TrimDateTime	DateModified `[get]`
	Gets the date the this rendition document was last modified. More...

string	Description `[get, set]`
	Gets or sets a string corresponding to the description field of this rendition. More...

ElectronicStore?	EStore `[get]`
	Gets the electronic store object where this rendition document is stored. More...

string	EStoreId `[get]`
	Gets a string containing the store id of this electornic document in its electronic store More...

string	Extension `[get]`
	Gets a string containing the file extension of this rendition document. More...

string	MimeType `[get, set]`
	Gets or sets the Internet media type (MIME type) for the attached electronic document. More...

int	NbrPages `[get, set]`
	Gets or sets the number of pages contained within the attached electronic document. More...

int	PageNumber `[get, set]`
	Gets or sets the page number of the single page view rendition. More...

RenditionType	TypeOfRendition `[get, set]`
	Gets or sets a rtRenditionType enum value indicating the type of this rendition. More...

bool	CanModifyExistingNotes `[get]`

bool	CanAddToNotes `[get]`

string	Notes `[get, set]`

bool	IsDocumentInClientCache `[get]`

string	DocumentPathInClientCache `[get]`

string	DocumentPathInWGSCache `[get]`

Properties inherited from TRIM.SDK.TrimChildObject
string	Name `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

uint	Idx `[get]`
	Gets the position in the child object list that this child object occupies. More...

Properties inherited from TRIM.SDK.TrimObject
BaseObjectTypes	TrimType `[get]`
	Gets a BaseObjectTypes enum value indicating the type of this object. More...

TrimURI	Uri `[get]`
	Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...

string	URN `[get]`
	Gets the uniform resource name for this object. More...

string	NameString `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

string	NameStringExtra `[get]`
	Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...

bool	IsReadOnly `[get]`
	Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...

bool	PossiblyHasSubordinates `[get]`
	Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. 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...

Properties inherited from TRIM.SDK.ITrimNotes
bool	CanModifyExistingNotes `[get]`
	Gets a boolean parameter indicating whether the current user can modify the existing notes attached to this object. More...

bool	CanAddToNotes `[get]`
	Gets a boolean value indicating whether the current user can either append or prepend some text to the existing notes. More...

string	Notes `[get, set]`
	Gets or sets a string value corresponding to the notes attached to this object. More...

Properties inherited from TRIM.SDK.ITrimDocument
bool	IsDocumentInClientCache `[get]`
	Gets a boolean value indicating whether the document associated with this object is currently inside the client document cache. More...

string	DocumentPathInClientCache `[get]`
	Gets a String value representing the path to a copy of the document associated with this object within the client document cache. For records, access is logged as a 'View'. More...

Detailed Description

The RecRendition object represents one of a Record's electronic attachments. It is therefore only available if the Record has an Electronic Document associated with it

Member Function Documentation

◆ Extract()

string TRIM.SDK.RecordRendition.Extract	(	string	outputDocumentName,
		bool	setDocumentAsReadOnly
	)

Extracts this Rendition to the file system location specified in the 'OutputDocumentName' parameter. If 'TEMP' is specified, the rendition will be extracted to the TEMP directory for the machine and a file name will be generated. Returns a string containing the filename of the extracted document.

◆ GetDocumentPathInClientCache()

string TRIM.SDK.RecordRendition.GetDocumentPathInClientCache ( Events logAccessAs )

Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type.

Implements TRIM.SDK.ITrimDocument.

◆ GetDocumentPathInWGSCache()

string TRIM.SDK.RecordRendition.GetDocumentPathInWGSCache ( Events logAccessAs )

◆ GetExtractDocument()

ExtractDocument TRIM.SDK.RecordRendition.GetExtractDocument ( )

◆ LoadDocumentIntoClientCache()

void TRIM.SDK.RecordRendition.LoadDocumentIntoClientCache ( )

Loads the document associated with this object into the client document cache, if one is available.

Implements TRIM.SDK.ITrimDocument.

◆ SetDocument()

void TRIM.SDK.RecordRendition.SetDocument ( string fromFileName )

Set the document associated with this Trim object as a copy of the supplied file name

Implements TRIM.SDK.ITrimDocument.

◆ SetNotes()

void TRIM.SDK.RecordRendition.SetNotes	(	string	NewNotesText,
		NotesUpdateType	TypeOfNotesUpdate
	)

Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them.

Implements TRIM.SDK.ITrimNotes.

◆ TransferStorageInPlace()

void TRIM.SDK.RecordRendition.TransferStorageInPlace	(	ElectronicStore	newDocumentStore,
		string	NewDocumentStoreId
	)

Transfers the electronic document attached to this rendition from its current storage location to a new electronic store at the specified location

Property Documentation

◆ AddedOn

TrimDateTime TRIM.SDK.RecordRendition.AddedOn

get

Gets the date this rendition was added to the parent record.

◆ Bytes

long TRIM.SDK.RecordRendition.Bytes

get

Gets an integer containing the size (in bytes) of this rendition document.

◆ CanAddToNotes

bool TRIM.SDK.RecordRendition.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.RecordRendition.CanModifyExistingNotes

get

◆ CheckedInBy

Location? TRIM.SDK.RecordRendition.CheckedInBy

get

Gets a location object that represents the person who checked in this rendition.

◆ CheckedInOn

TrimDateTime TRIM.SDK.RecordRendition.CheckedInOn

get

Gets the date on which this rendition was checked in.

◆ ConfidenceLevel

int TRIM.SDK.RecordRendition.ConfidenceLevel

getset

Gets or sets a number indicating the confidence level associated with the OCR pattern matching process (1-100), 0 = unknown.

◆ DateModified

TrimDateTime TRIM.SDK.RecordRendition.DateModified

get

Gets the date the this rendition document was last modified.

◆ Description

string TRIM.SDK.RecordRendition.Description

getset

Gets or sets a string corresponding to the description field of this rendition.

◆ DocumentPathInClientCache

string TRIM.SDK.RecordRendition.DocumentPathInClientCache

get

◆ DocumentPathInWGSCache

string TRIM.SDK.RecordRendition.DocumentPathInWGSCache

get

◆ EStore

ElectronicStore? TRIM.SDK.RecordRendition.EStore

get

Gets the electronic store object where this rendition document is stored.

◆ EStoreId

string TRIM.SDK.RecordRendition.EStoreId

get

Gets a string containing the store id of this electornic document in its electronic store

◆ Extension

string TRIM.SDK.RecordRendition.Extension

get

Gets a string containing the file extension of this rendition document.

◆ IsDocumentInClientCache

bool TRIM.SDK.RecordRendition.IsDocumentInClientCache

get

◆ MimeType

string TRIM.SDK.RecordRendition.MimeType

getset

Gets or sets the Internet media type (MIME type) for the attached electronic document.

◆ NbrPages

int TRIM.SDK.RecordRendition.NbrPages

getset

Gets or sets the number of pages contained within the attached electronic document.

◆ Notes

string TRIM.SDK.RecordRendition.Notes

getset

◆ PageNumber

int TRIM.SDK.RecordRendition.PageNumber

getset

Gets or sets the page number of the single page view rendition.

◆ TypeOfRendition

RenditionType TRIM.SDK.RecordRendition.TypeOfRendition

getset

Gets or sets a rtRenditionType enum value indicating the type of this rendition.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Extract()

◆ GetDocumentPathInClientCache()

◆ GetDocumentPathInWGSCache()

◆ GetExtractDocument()

◆ LoadDocumentIntoClientCache()

◆ SetDocument()

◆ SetNotes()

◆ TransferStorageInPlace()

Property Documentation

◆ AddedOn

◆ Bytes

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ CheckedInBy

◆ CheckedInOn

◆ ConfidenceLevel

◆ DateModified

◆ Description

◆ DocumentPathInClientCache

◆ DocumentPathInWGSCache

◆ EStore

◆ EStoreId

◆ Extension

◆ IsDocumentInClientCache

◆ MimeType

◆ NbrPages

◆ Notes

◆ PageNumber

◆ TypeOfRendition