Defines a location for electronic documents that are to be transferred into Content Manager
More...
|
| | DocumentQueue (Database database, TrimURI uri) |
| |
| | DocumentQueue (Database database, string name) |
| |
| | DocumentQueue (Database database) |
| |
| DocumentQueue | NewCopy () |
| |
| 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 | ApplyUserLabel (UserLabel userLabelToApply) |
| | Creates a link between the nominated user label and this object. More...
|
| |
| void | DetachUserLabel (UserLabel userLabelToDetach) |
| | Removes the link between the nominated user label and this object. More...
|
| |
| void | AddToFavorites () |
| | Adds the object to the special user label called 'Favorites' More...
|
| |
| void | RemoveFromFavorites () |
| | Removes the object from the special user label called 'Favorites' More...
|
| |
| bool | ChangePositionWithinFavorites (LabelPositionChange positionChange) |
| | Changes the position of this object within a users list of favorite objects of this type More...
|
| |
| bool | ChangePositionWithinUserLabel (UserLabel label, LabelPositionChange positionChange) |
| | Changes the position of this object within a users list of objects that have been labeled with the specified user label More...
|
| |
 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...
|
| |
| 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...
|
| |
| 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...
|
| |
|
| bool | AllowAutomaticProcessing [get, set] |
| | Gets or sets a Boolean value indicating whether automatic processing of this Document Queue is allowed. If true, the Document Queue Processor program (TRIMQueue.exe) will automatically process any documents upon being placed in the Document Queue folder. More...
|
| |
| bool | AutoViewDocuments [get, set] |
| | Gets or sets a Boolean value indicating whether documents from this Document Queue should be automatically displayed to the user once selected in the list of queued documents. More...
|
| |
| bool | CheckLinks [get, set] |
| | Gets or sets a Boolean value indicating whether a check for internal (compound) OLE links to other documents should be carried out. This option operates independently from the 'User Options - General tab - Ignore linked documents when checking in a document' option. More...
|
| |
| Classification | Classification [get, set] |
| | Gets or sets the default classification that should be used to classify records created from this Document Queue. More...
|
| |
| bool | ConfirmCheckIn [get, set] |
| | Gets or sets a Boolean value indicating whether the check in of each document should be confirmed by the user through a dialog. If false, the 'Check In' dialog box will be bypassed. More...
|
| |
| Record | Container [get, set] |
| | Gets or sets the default container record that should be used to contain records created from this Document Queue. This container can be used to synchronize the contents of your Windows folder with Content Manager. More...
|
| |
| bool | DisplayEntryForm [get, set] |
| | Gets or sets a Boolean value indicating whether the entry form should be displayed when creating new records from this Document Queue. If false, the entry form may still be displayed, if there are mandatory data entry fields for the record that are not able to be populated by details of the document; if not, then it will be bypassed. More...
|
| |
| DocumentUpdateStyles | DocumentUpdateStyle [get, set] |
| | Gets or sets a documentUpdateStyles enum value indicating what to do with a document after it has been processed by the document queue processor. Only applicable for a document queue based on files within a windows file system. More...
|
| |
| EmailUpdateStyles | EmailUpdateStyle [get, set] |
| | Gets or sets a emailUpdateStyles enum value indicating what to do with an email message after it has been processed by the document queue processor. Only applicable for a document queue that is based on email items. More...
|
| |
| bool | IgnoreOriginals [get, set] |
| | Gets or sets a Boolean value indicating whether only 'Draft' and 'Modified' Electronic Documents (i.e. only documents that have been checked out of Content Manager) should be checked in from this Document Queue. This will have the effect of ignoring any documents that have not been cataloged in Content Manager. More...
|
| |
| TrimDateTime | LastProcessed [get] |
| | Gets the date this Document Queue was last processed. More...
|
| |
| string | Location [get, set] |
| | Gets or sets a string containing the file path to the document queue. More...
|
| |
| string | LocationDisplay [get, set] |
| | Gets or sets a string containing a readable display name for the location that is to be processed by this document queue. More...
|
| |
| string | Machine [get, set] |
| | Gets or sets a string containing the machine name where the directory for this Document Queue is located. Having a value indicates that the queue can only be accessed from this machine. If blank, this Document Queue has a generic directory path and may be used by anyone. More...
|
| |
| new string | Name [get, set] |
| | Gets or sets a string containing the name of the Document Queue represented by this DocumentQueue object. More...
|
| |
| QueueTypes | QueueType [get, set] |
| | Gets or sets a qtQueueTypes enum value indicating the type of this Document Queue. It may be a Windows folder, Notes folder, FTP directory, MAPI folder, Outlook folder, or a temporary file list. More...
|
| |
| RecordType | RecordType [get, set] |
| | Gets or sets the default record type that should be used when creating new Records from documents in this Document Queue. More...
|
| |
| string | SelectFilter [get, set] |
| | Gets or sets a string listing file extensions of documents from this Document Queue to be processed, with file extensions delimited by semicolons. The document queue will be restricted to listing documents that match these extensions. If this string is empty, the Document Queue will process all files not excluded by the File Type Filters. More...
|
| |
| bool | ShowBinaryFiles [get, set] |
| | Gets or sets a Boolean value indicating whether the Document Queue should allow processing of Binary Files (i.e. application files such as those with extension '.exe', '.dll', '.obj'). If set to false these files will not be listed in the Queue. More...
|
| |
| bool | ShowHiddenFiles [get, set] |
| | Gets or sets a Boolean value indicating whether the Document Queue should allow processing of hidden files (i.e. files that are hidden by the operating system). If set to false these files will not be listed in the Queue. More...
|
| |
| bool | ShowReferenceFiles [get, set] |
| | Gets or sets a Boolean value indicating whether the Document Queue should allow processing of Content Manager Reference Files (i.e. files with a '.tr5' extension which link to objects in a Content Manager dataset). If set to false these files will not be listed in the Queue. More...
|
| |
| bool | ShowRenditions [get, set] |
| | Gets or sets a Boolean value indicating whether the DocumentQueue should allow processing of Rendition Files (i.e. alternative copies of documents in different formats such as those with extensions defined as renditions in Content Manager Enterprise Manager). If set to false these files will not be listed in the Queue. More...
|
| |
| bool | ShowSystemFiles [get, set] |
| | Gets or sets a Boolean value indicating whether the Document Queue should allow processing of system files (i.e. files that are used by the operating system). If set to false these files will not be listed in the Queue. More...
|
| |
| bool | CanModifyExistingNotes [get] |
| |
| bool | CanAddToNotes [get] |
| |
| string | Notes [get, set] |
| |
| TrimAccessControlList | AccessControlList [get, set] |
| |
| 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...
|
| |
| bool | PossiblyHasSubordinates [get] |
| | Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. 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 | 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...
|
| |
| TrimAccessControlList | AccessControlList [get, set] |
| | Gets or sets the access control list attached to this object. More...
|
| |
Defines a location for electronic documents that are to be transferred into Content Manager
1.8.11 
