|
| 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 (HistoryTypes 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 (HistoryTypes logAccessAs) |
| |
| ExtractDocument | GetExtractDocument () |
| |
| string | Extract (string outputDocumentName, bool setDocumentAsReadOnly) |
| | Extracts this Revision to the file system location specified in the 'OutputDocumentName' parameter. If 'TEMP' is specified, the revision 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 | Promote () |
| | Extracts this revision and promotes to be the latest revision of the record. Note that the function automatically commits - no Save() is required. More...
|
| |
| void | TransferStorageInPlace (ElectronicStore newDocumentStore, string NewDocumentStoreId) |
| | Transfers the electronic document attached to this revision from its current storage location to a new electronic store at the specified location More...
|
| |
| void | Delete () |
| | Permanently removes this object and all its associated child objects from the database. More...
|
| |
| 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...
|
| |
| 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...
|
| |
|
| long | Bytes [get] |
| | Gets an integer containing the size of the Electronic Document corresponding to this Revision in bytes. More...
|
| |
| Location | CheckedInBy [get] |
| | Gets a location object that represents the person who checked in this revision. More...
|
| |
| TrimDateTime | DateModified [get] |
| | Gets the date the Electronic Document attached as this Revision was last modified. More...
|
| |
| string | Description [get] |
| | Gets a string containing the source of this revision, that is the file path from which it was originally checked in. More...
|
| |
| string | DocumentType [get] |
| | Gets a string containing the type of the Electronic Document corresponding to this Revision. More...
|
| |
| ElectronicStore | EStore [get] |
| | Gets the ElectronicStore object in which the Electronic Document corresponding to this Revision is kept. More...
|
| |
| string | EStoreId [get] |
| | Gets a string containing the filename (Store ID) of the Electronic Document corresponding to this Revision in the Electronic Store where it is kept. More...
|
| |
| string | Extension [get] |
| | Gets a string containing the file extension of this Revision's attached Electronic Document. For example: 'pdf'. More...
|
| |
| string | MimeType [get] |
| | Gets the Internet media type (MIME type) for this revision of the electronic document. More...
|
| |
| int | NbrPages [get] |
| | Gets the number of pages contained within this revision of the electronic document. More...
|
| |
| string | PreservationNotes [get, set] |
| | Gets or sets a string property describing the preservation notes for this revision, indicating why the revision should be preserved. More...
|
| |
| bool | Preserve [get, set] |
| | Gets or sets a Boolean value indicating if this Revision should be preserved. This flags a Revision as being significant and therefore prevents it from being removed when the document is finalized or when a user elects to delete previous Revisions. More...
|
| |
| int | RevisionNumber [get] |
| | Gets the number of this Revision. The original document will have Revision Number = 1. More...
|
| |
| bool | IsDocumentInClientCache [get] |
| |
| string | DocumentPathInClientCache [get] |
| |
| string | DocumentPathInWGSCache [get] |
| |
| 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...
|
| |
| 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...
|
| |
| 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...
|
| |
| 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...
|
| |
The RecRevision may be used only if the Record has an Electronic Document associated with it. The object is a child object and represents a revision of a Record's electronic document.
Public Member Functions inherited from HP.HPTRIM.SDK.TrimChildObject
1.8.11 
