Document |  |
Represents an item in ReadySuite. Contains a collection of field
data, PageItem's, TextItem's and
NativeItem.
Inheritance HierarchyNamespace: Compiled.EDD.Scripting
Assembly: Compiled.EDD.Scripting (in Compiled.EDD.Scripting.dll) Version: 9.0.0.0-142fa9725
SyntaxC#
public sealed class DocumentItem
The DocumentItem type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BatesBeg | Represents the starting identifier for the first page in the document. |
| BatesEnd | Represents the ending identifier for the last page in the document |
| DocId | Represents the document identifier field value. Typically seen as DocID* on the document grid. |
| Parent | Gets or sets the parent document. |
Methods| Name | Description | |
|---|---|---|
 | AddAttachment | Adds the provided document as an attachment to this document. |
| AddPage | Adds the page to the end of the page list for this document. |
| AddText | Adds the text item to the document. |
| ClearAttachments | Clears the attachments assigned to this document. |
| ClearPages | Clears (removes) all the PageItems from the document.. |
| ClearText | Clears (removes) all the text references for the document. |
| CreateChatEvent | Creates and ties a new chat event to this document. |
| Equals | Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object)) |
| GetAttachments | Gets the attachment documents belonging to this document. |
| GetChatEvent | Gets the chat event tied to this document. |
| GetFieldData(FieldItem) | Gets the field data from the document as a string. |
| GetFieldData(FieldItem, Boolean) | Gets the field data from the document as a string with option to set resource link handling. |
| GetFirstPage | Gets the first page of the document. |
| GetHashCode | Serves as the default hash function. (Overrides ObjectGetHashCode) |
| GetLastPage | Gets the last page of the document. |
| GetNative | Gets the NativeItem reference. |
| GetNewNative | Gets a new NativeItem reference which can be linked to this instance via SetNative(NativeItem) |
| GetNewPage | Gets a new PageItem reference which can be added to the page collection of this document via AddPage(PageItem). |
| GetNewText | Gets a new TextItem reference which can be linked to this instance via SetText(TextItem) |
| GetPageCount | Gets the page count. |
| GetPages | Gets the pages linked to the document. |
| GetText | Gets a list of TextItems for the document. |
| GetTextCount | Gets the number of associated text files linked to the document. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HasAttach | Determines whether the document has any attachment/child references. |
| HasFamily | Determines whether the document has any family information. |
| HasNative | Determines if the document item has a native file reference linked. |
| HasPages | Determines if the document item has page references linked to it. |
| HasText | Determines whether the document has any text file(s) linked. |
| IsAttach | Determines whether this document is an attachment to a parent document. |
| IsMultiFrame | Checks if the document contains images (pages) that are in a multi-page format. |
| IsParent | Determines whether this document is a parent reference. |
| IsRootParent | Determines whether this document is a root parent. |
| ReassignPageNumbers | Assigns new page numbers to the pages in the document. Call this method after removing pages from the document. |
| RemoveNative | Removes (clears) the native reference. |
| RemovePage | Removes the page reference from the document. |
| RemoveText | Removes the text item reference from the document. |
| SetFieldData(FieldItem, Boolean) | Sets the field data from a bool value for the document. The field type must match Boolean. |
| SetFieldData(FieldItem, DateTime) | Sets the field data from a DateTime value for the document. The field type must match Date, Time, or DateTime. |
| SetFieldData(FieldItem, Int64) | Sets the field data from a int value for the document. The field type must match Number. |
| SetFieldData(FieldItem, Object) | Sets the field data from an object value for the document. The object value must match the fields data type or an exception will be thrown. |
| SetFieldData(FieldItem, Single) | Sets the field data from a float value for the document. The field type must match Decimal. |
| SetFieldData(FieldItem, String) | Sets the field data from a string value for the document. |
| SetFieldData(IChoiceFieldItem, IEnumerableString, Boolean) | Allow to set values for choice and multi choice field |
| SetFieldData(IChoiceFieldItem, String, Char, Boolean) | Allow to set values for choice and multi choice field |
| SetNative | Sets the NativeItem reference for the document. |
| SetText | Clears existing references and sets the text item reference. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetFieldDataT | Attempts to get the field data from the document matching the type param. If the field data is not set, false is returned, and fieldData is set to default(T). If the field has data, and matches the type, true is returned, with fieldData set to the value. |
See Also