A document that has been temporarily stored outside of HPE Content Manager for offline access
More...
|
| | OfflineRecord (Database database, TrimURI uri) |
| | Constructor for a new Offline record - it creates a new draft document within the offline records list by copying the supplied document across More...
|
| |
| | OfflineRecord (Database database, string name) |
| | Constructor for a new Offline record - it creates a new draft document inside the specified folder by copying the supplied document across More...
|
| |
| | OfflineRecord (Database inDatabase, string newItemDisplayName, string newItemExtension, string createFromFile) |
| | Constructor for a new Offline record - it creates a new document in offline records by checking out the specified record. More...
|
| |
| | OfflineRecord (Database inDatabase, string newItemDisplayName, string newItemExtension, string createFromFile, OfflineRecord createInFolder) |
| | Constructor for a new Offline record - it creates a new document in offline records by checking out the specified record. More...
|
| |
| | OfflineRecord (Record recordToCheckOutOrCopy, bool checkDocumentOut) |
| |
| | OfflineRecord (Record recordToCheckOutOrCopy, bool checkDocumentOut, string comments) |
| |
| 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 () |
| |
 Public Member Functions inherited from HP.HPTRIM.SDK.TrimMainObject |
| virtual void | Save () |
| | Permanently commits all changes made to this object (and all its child objects). For new objects a new unique identifier will be allocated (Uri). More...
|
| |
| string | MakeReference (string SuggestName) |
| | Creates a TRIM reference file for this object, given the path and filename. A reference file can be associated with the Open command of various of the TRIM executables - TRIM.exe, TRIMDesktop.exe, etc. When the reference file is double-clicked, the associated application will then launch (or activate if it already running) and the object will then be displayed inside that executable. Returns a string containing the path and filename of the reference file created. More...
|
| |
| virtual void | Delete () |
| | Permanently removes this object and all its associated child objects from the database. More...
|
| |
| bool | IsDeleteOk () |
| | Determines if this object can be deleted. If it returns false, check the ErrorMessage details for more information. It is possible that the ErrorMessage property could contain a warning message even though the function returns true. More...
|
| |
| bool | Verify (bool failOnWarning) |
| | Verifies all properties that have been modified since this object was last saved. Returns a Boolean value indicating whether the function succeeded. If false, the error description is stored in the ErrorMessage property. More...
|
| |
| TrimChildObjectList | GetChildObjectList (BaseObjectTypes childType) |
| | Retrieves the child object collection of the nominated child object type. More...
|
| |
| TrimMainObject | GetNewCopy () |
| | Creates a new TrimMainObject which is a copy of this TrimMainObject. Where appropriate, property values are copied from this TrimMainObject to the new TrimMainObject. You will generally need to set any unique properties manually afterwards, prior to committing this new TrimMainObject to the TRIM database with the Save() method. See also the NewCopy function of the derived objects that implement this capability. Will return NULL if this object does not support the Copy function. More...
|
| |
| virtual void | Refresh () |
| | Resets this object to the current state on the database, will revert any changes that might have been made. Only required if you are not using BOBnotifications, or need to guarantee a really up-to-date version of the object state. 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...
|
| |
|
| string | AuthorName [get] |
| | Gets the author name for this offline record. More...
|
| |
| int | ContainedItemsCount [get] |
| | Gets the number of offline records contained within this folder ( if it is a folder). More...
|
| |
| OfflineRecord | Container [get, set] |
| | Gets or sets the offline record representing the folder that this record si contained within.. More...
|
| |
| Record | ContainerRecord [get] |
| | Gets the HPE Content Manager record that represents the offline record folder that this record is contained within. More...
|
| |
| string | ContainerTitle [get] |
| | Gets the title of the folder that this offline record is contained within. More...
|
| |
| TrimDateTime | DateCheckedOut [get] |
| | Gets the date that this offline record was checked out of HPE Content Manager. This is not applicable to draft offline records. More...
|
| |
| TrimDateTime | DateCreated [get] |
| | Gets the date that this offline record was created. More...
|
| |
| TrimDateTime | DateModified [get] |
| | Gets the file date modified for this offline record More...
|
| |
| TrimDateTime | DateModifiedAtCheckout [get] |
| | Gets the date modified of the current revision of this offline record in HPE Content Manager. This is not applicable to draft offline records. More...
|
| |
| string | Extension [get] |
| | Gets the extension of this offline record. More...
|
| |
| string | FileName [get] |
| | Gets the name of the file (on the windows file system) corresponding to this offline record. More...
|
| |
| string | FileType [get] |
| | Gets a string describing the type of offline file - either 'Folder' or the registered file type description based on the file extension. More...
|
| |
| string | FullFileName [get] |
| | Gets the full path name of this offline record, indicating where it resides within the Windows file system. More...
|
| |
| bool | IsADocument [get] |
| | Gets a boolean value indicating if this offline record is a document. More...
|
| |
| bool | IsAFolder [get] |
| | Gets a boolean value indicating if this offline record is a folder. More...
|
| |
| int | NextRevision [get] |
| | Gets the revision which will be assigned to this offline record when it is checked back into HPE Content Manager. More...
|
| |
| Record | Record [get] |
| | Gets the HPE Content Manager record that this offline record was created from (by doing a check out from HPE Content Manager). More...
|
| |
| string | RecordNumber [get] |
| | Gets the number of the HPE Content Manager record that this offline record was created from (by doing a check out from HPE Content Manager). More...
|
| |
| TrimURI | RecordUri [get] |
| | Gets the unique row identifier of the HPE Content Manager record that this offline record was created from (by doing a check out from HPE Content Manager). More...
|
| |
| long | Size [get] |
| | Gets the size of this offline record as a number of bytes More...
|
| |
| OfflineStatus | Status [get] |
| | Gets the status of this offline record More...
|
| |
| string | Title [get, set] |
| | Gets or sets the title of this offline record More...
|
| |
| bool | IsDocumentInClientCache [get] |
| |
| string | DocumentPathInClientCache [get] |
| |
| string | DocumentPathInWGSCache [get] |
| |
| Properties inherited from HP.HPTRIM.SDK.TrimMainObject |
| TrimDateTime | LastUpdatedOn [get] |
| | Returns the date and time that changes to this object were last committed. More...
|
| |
| 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...
|
| |
| bool | Verified [get] |
| | Gets a Boolean value indicating whether the object has been verified. That is, whether a call to the 'Verify' method has been made and has succeeded. More...
|
| |
| string | WebURL [get] |
| |
| bool | IsInFavorites [get] |
| | Gets a boolean value indicating whether this object is in the current user's list of favorites More...
|
| |
| string | UpdateComment [get, set] |
| | Gets or sets a string value to be recorded with any audit entries related to the update of this object 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...
|
| |
A document that has been temporarily stored outside of HPE Content Manager for offline access
1.8.11 
