Click or drag to resize

DocumentItem Methods

The DocumentItem type exposes the following members.

Methods
  NameDescription
Public methodAddAttachment
Adds the provided document as an attachment to this document.
Public methodAddPage
Adds the page to the end of the page list for this document.
Public methodAddText
Adds the text item to the document.
Public methodClearAttachments
Clears the attachments assigned to this document.
Public methodClearPages
Clears (removes) all the PageItems from the document..
Public methodClearText
Clears (removes) all the text references for the document.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodGetAttachments
Gets the attachment documents belonging to this document.
Public methodGetFieldData
Gets the field data from the document as a string.
Public methodGetFirstPage
Gets the first page of the document.
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetLastPage
Gets the last page of the document.
Public methodGetNative
Gets the NativeItem reference.
Public methodGetNewNative
Gets a new NativeItem reference which can be linked to this instance via SetNative(NativeItem)
Public methodGetNewPage
Gets a new PageItem reference which can be added to the page collection of this document via AddPage(PageItem).
Public methodGetNewText
Gets a new TextItem reference which can be linked to this instance via SetText(TextItem)
Public methodGetPageCount
Gets the page count.
Public methodGetPages
Gets the pages linked to the document.
Public methodGetText
Gets a list of TextItems for the document.
Public methodGetTextCount
Gets the number of associated text files linked to the document.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasAttach
Determines whether the document has any attachment/child references.
Public methodHasFamily
Determines whether the document has any family information.
Public methodHasNative
Determines if the document item has a native file reference linked.
Public methodHasPages
Determines if the document item has page references linked to it.
Public methodHasText
Determines whether the document has any text file(s) linked.
Public methodIsAttach
Determines whether this document is an attachment to a parent document.
Public methodIsMultiFrame
Checks if the document contains images (pages) that are in a multi-page format.
Public methodIsParent
Determines whether this document is a parent reference.
Public methodIsRootParent
Determines whether this document is a root parent.
Public methodReassignPageNumbers
Assigns new page numbers to the pages in the document. Call this method after removing pages from the document.
Public methodRemoveNative
Removes (clears) the native reference.
Public methodRemovePage
Removes the page reference from the document.
Public methodRemoveText
Removes the text item reference from the document.
Public methodSetFieldData(FieldItem, Boolean)
Sets the field data from a bool value for the document. The field type must match Boolean.
Public methodSetFieldData(FieldItem, DateTime)
Sets the field data from a DateTime value for the document. The field type must match Date, Time, or DateTime.
Public methodSetFieldData(FieldItem, Int32)
Sets the field data from a int value for the document. The field type must match Number.
Public methodSetFieldData(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.
Public methodSetFieldData(FieldItem, Single)
Sets the field data from a float value for the document. The field type must match Decimal.
Public methodSetFieldData(FieldItem, String)
Sets the field data from a string value for the document.
Public methodSetFieldData(IChoiceFieldItem, IEnumerableString, Boolean)
Allow to set values for choice and multi choice field
Public methodSetFieldData(IChoiceFieldItem, String, Char, Boolean)
Allow to set values for choice and multi choice field
Public methodSetNative
Sets the NativeItem reference for the document.
Public methodSetText
Clears existing references and sets the text item reference.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetFieldDataT
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.
Top
See Also