• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Namespace DRIT.Document

Classes

AbstractCollection<T>

Provides a mutable, zero-based, ordered collection of document objects.

AdvancedCompareOptions

Provides advanced comparison controls in addition to CompareOptions.

Bibliography

Owns the bibliography sources associated with a document.

Body

Represents the main story body of a document section.

Bookmark

Represents a single bookmark.

BookmarkCollection

Represents a BookmarkCollection.

Border

Represents a Border.

BorderCollection

Represents a BorderCollection.

BuildingBlock

Represents one Quick Part or glossary entry in a document template.

BuildingBlockCollection

Provides ordered access to a glossary document's building blocks.

BuiltInDocumentProperties

Represents a BuiltInDocumentProperties.

Certificate

Wraps an X.509 certificate used for digitally signing a document. Provides a lightweight, document-focused view of the underlying X509Certificate2.

CharacterFormatRevision

Represents a character format revision — tracks the format that was in effect before a formatting change was made. The PreviousFormat snapshot can be restored by calling Reject.

CharacterStyleDefinition

Defines a custom character style that will be serialized to styles.xml.

Color

Represents a Color.

Comment

Represents a Comment.

CommentAnchorInfo

Represents a CommentAnchorInfo.

CommentAuthor

Represents a comment author tracked across a document.

CommentCollection

Represents a CommentCollection.

CompareOptions

Controls the scope and granularity of a document comparison.

CompatibilityOptions

Provides document compatibility and legacy layout settings.

CompositeNode

Represents a CompositeNode.

ContentControl

Represents a structured document tag (content control).

ContentControlCollection

Contains content controls associated with a paragraph.

ContentControlListItem

Represents one option in a combo-box or drop-down-list content control.

ContentControlProperties

Stores editable properties of a content control.

ContentPosition

Represents a cursor position in a document story.

ContentRange

Represents a mutable range of text in a document story.

Contributor

Represents a person or organization associated with a bibliography source.

Corporate

Represents an organization that contributed to a bibliography source.

CustomXmlPart

Represents a custom XML part stored in a document package.

CustomXmlPartCollection

An ordered collection of CustomXmlPart objects belonging to a document.

Document

Represents a Document.

DocumentBase

Provides the common document-level collections and node behavior.

DocumentContentRange

Provides document-order access to the section-owned main-story blocks.

DocumentLoadOptions

Options used when loading a document.

DocumentMailMergeOptions

Configures value binding and fallback behavior during a mail merge.

DocumentPageInfo

Describes one page produced by the document layout engine.

DocumentPaginator

Paginates a document by running the internal layout engine to determine page boundaries. Uses the same flow engine as PDF export.

DocumentPropertyCollection

Provides ordered and name-based access to document properties.

DocumentProtection

Provides access to document protection settings.

DocumentSaveOptions

Options used when saving a document.

DocumentSettings

Represents a DocumentSettings.

DocumentSplitOptions

Configures a structural document split operation.

DocumentSplitPart

Represents one independent result of a structural document split.

DocumentSplitter

Splits a document into independent structural parts without modifying the source document.

DocumentTextMatch

Represents a DocumentTextMatch.

DocumentVisitor

Provides callbacks for traversing a document node tree.

DocxDigitalSignatureInfo

Read-only metadata about a digital signature present in a DOCX package.

DocxDigitalSignatureSaveOptions

Digital signature parameters for DOCX save operations.

DocxEncryptionOptions

Configures password-based encryption for a DOCX package.

DocxEncryptionPasswordException

Indicates that a password could not decrypt an encrypted DOCX package.

DocxLoadOptions

Options used when loading a Word Open XML document.

DocxSaveOptions

Options used when saving a Word Open XML document.

EditableRange

Describes a region of document content that may be edited by a permitted editor.

EditableRangeCollection

Provides indexed access to editable ranges in a document.

EditableRangeEnd

Represents the ending marker of an editable range.

EditableRangeStart

Represents the beginning marker of an editable range.

EditableRangeValidationIssue

Describes a validation problem in an editable range.

EditableRangeValidationResult

Contains validation issues found in editable range markers.

EndnoteOptions

Represents the endnote numbering and placement options for a document or section.

Field

Represents a Field.

FieldBuilder

Builds fields with typed Word instructions.

FieldMergingEventArgs

Provides data for a mail-merge field callback.

FileFormatInfo

Describes the format and package capabilities detected for a file.

FileFormatUtil

Detects document formats and package capabilities from file paths.

FindReplaceOptions

Configures a find or replace operation.

Font

Represents a Font.

Footnote

Represents a Footnote.

FootnoteOptions

Represents the footnote numbering options for a document or section.

FootnoteSeparator

Represents the editable text story for one footnote or endnote separator.

FootnoteSeparatorCollection

Provides access to the footnote and endnote separator stories in a document.

FormCheckBoxData

Represents the data for a check-box form field (FORMCHECKBOX).

FormDropDownData

Represents the data for a drop-down list form field (FORMDROPDOWN).

FormFieldData

Base class for form field data. Contains properties common to all form field types (text, check-box, drop-down).

FormFieldDataCollection

A read-only collection of all form fields in a document, accessible by name or index.

FormTextData

Represents the data for a text-input form field (FORMTEXT).

FormatRevision<TFormat>

Base class for revisions that retain a typed snapshot of the format that was in effect before a formatting change.

FrameFormat

Describes the position and layout of a legacy Word paragraph frame.

Frameset

Represents a legacy Word frames page or a single frame.

FramesetCollection

Provides indexed and enumerable access to frameset children.

GlossaryDocument

Represents the glossary document that stores Quick Parts and building blocks.

HeaderFooter

Represents a container for the header or footer text of a section.

HeaderFooterCollection

Represents a HeaderFooterCollection.

HtmlFixedSaveOptions

Save options for fixed-layout (paginated) HTML files. Each page is rendered as a fixed-size div with absolutely-positioned elements.

HtmlLoadOptions

Load options for HTML files.

HtmlSaveOptions

Save options for flow-layout HTML files.

HtmlSplitAsset

Describes a binary asset emitted while splitting a document to HTML.

HtmlSplitOptions

Configures structural topic splitting and HTML artifact generation.

HtmlSplitResult

Describes the files generated by an HTML topic split.

HtmlSplitTopic

Describes one generated HTML topic file.

Hyperlink

Represents a hyperlink associated with a document element.

Hyphenation

Provides process-level registration and lookup of custom hyphenation dictionaries.

HyphenationDictionary

Provides hyphenation points for words in a specific language.

ImageFieldMergingEventArgs

Provides data for a mail-merge image field callback.

ImageSaveOptions

Options used when rendering document pages to raster images.

Inline

Represents a Inline.

InterruptionToken

Propagates a cooperative cancellation request to long-running save, load, and export operations.

InterruptionTokenSource

Represents the InterruptionTokenSource API type.

LicenseException

Thrown when a licensed output operation is attempted without a valid license.

LoadOptions

Abstract base class for all load options.

MailMerge

Executes mail merges against a document.

MailMergeDiagnostic

Describes an issue observed while executing a mail merge.

MailMergeFieldInfo

Describes one scalar field occurrence in a mail-merge template.

MailMergeFormattingOptions

Controls deterministic formatting of resolved mail-merge values.

MailMergeImageOptions

Controls rich image insertion during a mail merge.

MailMergeImageSource

Describes image bytes supplied to a mail merge.

MailMergeRegionInfo

Describes one repeating region occurrence in a mail-merge template.

MailMergeResult

Reports the work and recoverable issues from a mail merge.

MailMergeTemplateAnalysis

Reports the static structure and source compatibility of a mail-merge template.

MarkdownLoadOptions

Options used when loading a Markdown file.

MarkdownSaveOptions

Options used when saving a Markdown file.

MoveRangeSeparator

Represents the start or end separator of a tracked move range. Separators carry move metadata; the associated content revision is exposed as a Revision on the moved run.

Node

Represents a Node.

NodeCollection

Represents a NodeCollection.

NodeImporter

Copies document nodes between documents while remapping styles and lists.

NoteCollection

Represents a NoteCollection.

OdtLoadOptions

Options used when loading an OpenDocument Text file.

OdtSaveOptions

Options used when saving an OpenDocument Text file.

OfficeMath

Represents an Office Open XML math equation embedded in a paragraph.

OfficeMathCollection

Contains office math objects belonging to a paragraph.

OleObject

Represents an OLE object associated with a shape.

OleObjectCollection

A collection of OleObject objects belonging to a document.

OperationProgressEventArgs

Provides data for the ProgressChanged event.

PageSetup

Represents a PageSetup.

Paragraph

Represents a paragraph and its runs, fields, links, and inline objects.

ParagraphBorderSet

Represents the ParagraphBorderSet API type.

ParagraphCollection

Provides ordered access to the paragraphs in a story.

ParagraphFormat

Represents a ParagraphFormat.

ParagraphFormatRevision

Represents a tracked change to paragraph formatting.

PatternHyphenationDictionary

Provides hyphenation points from TeX-style patterns and language-specific exceptions.

Person

Represents an individual contributor to a bibliography source.

ReplacingArgs

Provides information about a match supplied to a replacing callback.

Revision

Represents a tracked change revision on a document element (Run, Paragraph, TableRow). Each revision carries accept/reject delegates that perform the appropriate mutation on the owning element.

RevisionCollection

A collection of all revisions in a document. The collection is lazy — it walks the document tree on each enumeration to collect current (unresolved) revisions.

Use AcceptAll() to accept every revision, or RejectAll() to reject every revision, or iterate and call Accept() / Reject() selectively.

RevisionGroup

Represents one contiguous group of revisions made by the same author.

RevisionGroupCollection

A snapshot of contiguous revision groups in document order. Adjacent revisions are grouped only when their authors match.

RevisionOptions

Controls how tracked changes are presented by consumers of a document. These options do not alter the document tree or resolve revisions.

RowCollection

Represents a RowCollection.

RtfLoadOptions

Options used when loading an RTF file.

RtfSaveOptions

Options used when saving an RTF file.

Run

Represents a contiguous range of text and character formatting.

RunCollection

Provides ordered access to the runs in a paragraph.

SaveOptions

Abstract base class for all save/export options.

Section

Represents a document section and its stories and page settings.

SectionCollection

Provides ordered access to the sections in a document.

SectionPropertiesRevision

Represents a tracked change to section properties.

Shading

Represents a Shading.

Source

Represents a bibliography source and its publication metadata.

Story

Base class for elements that contain block-level nodes Paragraph and Table.

Style

Defines reusable character, paragraph, and list formatting.

StyleCollection

Represents a StyleCollection.

SvgSaveOptions

Options used when exporting document content as SVG.

TabStop

Represents a single tab stop on a paragraph. The Position is expressed in points; Alignment and Leader mirror the Word "Tabs" dialog.

TabStopCollection

A collection of TabStop objects on a ParagraphFormat. Tab stops are kept in insertion order.

TableBorder

Represents a border of a table or table cell

TableCellFormatRevision

Represents a tracked change to table-cell formatting.

TableCollection

Provides ordered access to the tables in a story.

TableColumnCollectionRevision

Represents a tracked change to a table's column collection.

TableFormatRevision

Represents a tracked change to table-level formatting.

TableOfContents

Represents a table of contents in a document. Holds the generation options and the computed entries. Use UpdateTableOfContents() to populate the entries by walking the document headings.

TableOfContentsEntry

Represents a single entry in a TableOfContents.

TableOfContentsEntryCollection

A collection of TableOfContentsEntry objects.

TableOfContentsOptions

Options that control how a TableOfContents is generated. Mirrors the Word "Table of Contents" dialog options and the TOC field switches.

TableRowFormatRevision

Represents a tracked change to table-row formatting.

TagCollection

A key-value collection of string tags for custom data storage on shapes. Keys are case-sensitive. Maps to the OOXML p:custDataLst/p:tagLst elements.

TeXHyphenationDictionaryLoader

Loads common TeX hyphenation pattern files into a reusable dictionary.

TextColumn

Represents a single text column. TextColumn is a member of the TextColumnCollection collection. The TextColumns collection includes all the columns in a section of a document.

TextColumnCollection

Represents a TextColumnCollection.

TxtLoadOptions

Options used when loading a plain-text file.

TxtSaveOptions

Options used when saving a plain-text file.

VariableCollection

A key-value collection of document variables (string name → string value). Maps to the OOXML w:docVars/w:docVar elements in settings.xml. Variables are used by fields and macros.

ViewOptions

Controls the view and zoom used when a document is opened.

WriteProtection

Provides access to write-protection settings for a document. Write protection recommends that the document be opened as read-only. An optional password can be set that is required to disable the write protection. Maps to <w:writeProtection> in settings.xml.

XmlMapping

Describes a content-control binding to a custom XML part.

XpsSaveOptions

Options used when exporting a fixed-layout XPS document.

Interfaces

IHyphenationCallback

Supplies a hyphenation dictionary when a requested language is not registered.

IMailMergeDataSource

Provides named records and values to the mail-merge data-binding engine.

IParagraph

Defines the IParagraph contract.

IProgressCallback

Callback interface for reporting progress during long-running save, load, and export operations.

IReplacingCallback

Defines a callback that controls replacement of individual matches.

IRevisionCriteria

Defines a predicate used to select tracked-change revisions.

Enums

Alignment

Text alignment of a Paragraph.

AutoFitBehavior

Specifies how a table automatically sizes its columns.

AutosizeType

How a Table should auto resize.

BorderStyle

Table Cell Border styles source: http://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing.tablecellborders.aspx

BorderType

Identifies a BorderType value.

BreakType

Identifies a BreakType value.

BuildingBlockBehavior

Specifies how a building block is inserted into a document.

BuildingBlockGallery

Specifies the Quick Parts gallery associated with a building block.

BuildingBlockType

Specifies the kind of content represented by a building block.

CapsStyle

Change the caps style of text, for use with Append and AppendLine.

ComparisonTargetType

Specifies which side of a comparison supplies the resulting document view.

Compatibility

Identifies compatibility switches supported by the public compatibility model.

ContainerType

Identifies a ContainerType value.

ContentControlType

Identifies the Word content-control type.

CssStyleSheetType

Controls how CSS stylesheets are written when saving to HTML.

Direction

Identifies a Direction value.

DisplacedByCustomXml

Specifies how a range marker is displaced by custom XML.

DocumentProtectionType

Specifies the type of document protection applied to a document. Maps to the OOXML ST_DocProtect simple type.

DocumentSecurity

Identifies a DocumentSecurity value.

DocumentSplitCriteria

Specifies the structural boundary used to split a document.

DocxDigitalSignatureHashAlgorithm

Selects the XML digest algorithm used for new OPC digital signatures.

DocxDigitalSignatureTrustMode

Controls how certificate trust is evaluated for a DOCX digital signature.

DocxEncryptionExpectation

Indicates what encryption type the caller expects when loading DOCX files.

DocxEncryptionMode

Selects the package encryption mode when saving DOCX files.

EditRestrictions

Identifies a EditRestrictions value.

EditType

Identifies a EditType value.

EditorType

Specifies which editor group may edit an editable range.

EndnotePosition

Defines the endnote position.

FieldType

Specifies the type of a Field, parsed from the field instruction. Mirrors the common Word field codes.

FindReplaceDirection

Specifies the direction in which find and replace operations visit matches.

FootnoteNumberingRule

Determines when automatic footnote or endnote numbering restarts.

FootnotePosition

Identifies a FootnotePosition value.

FootnoteSeparatorType

Identifies one of the special separator stories in a Word footnotes or endnotes part.

FootnoteType

Specifies whether a note is a footnote or an endnote.

FormFieldType

Specifies the type of a form field.

FormTextType

Specifies the text type for a text-input form field. Maps to the OOXML ST_FFTextType simple type.

FormatType

Identifies document formats supported by the document load and detection APIs.

FrameDropCap

Specifies how a paragraph frame is used as a drop cap.

FrameHeightRule

Specifies how a frame height is calculated.

FrameHorizontalAlignment

Specifies horizontal frame alignment.

FrameHorizontalAnchor

Specifies the horizontal reference for a paragraph frame.

FrameVerticalAlignment

Specifies vertical frame alignment.

FrameVerticalAnchor

Specifies the vertical reference for a paragraph frame.

FrameWrap

Specifies how text wraps around a paragraph frame.

Granularity

Specifies the smallest unit considered by document comparison.

HeaderFooterType

Identifies a HeaderFooterType value.

HeadingType

Identifies a HeadingType value.

HeightRule

Identifies a HeightRule value.

HighlightColorValues

Identifies a HighlightColorValues value.

HtmlControlType

Controls how HTML form elements (<select>, <input>) are mapped when loading HTML into a Document.

HtmlElementSize

Controls the unit used for table widths in HTML output.

HtmlFixedPageHorizontalAlignment

Horizontal alignment of pages in fixed-layout HTML.

HtmlMetafileFormat

Controls how metafiles (EMF/WMF) are rendered in HTML output.

HtmlSplitFileNamePolicy

Controls how topic file names are generated.

HtmlSplitRelativeLinkPolicy

Controls how links between generated HTML files are written.

ImageSaveFormat

Image formats supported by the image export option contract.

ImportFormatMode

Specifies how formatting is handled when content is imported from another document.

JustificationMode

Identifies the compatibility justification behavior used for paragraphs.

LineNumberRestartMode

Identifies a LineNumberRestartMode value.

LineSpacingRule

Identifies a LineSpacingRule option.

LineSpacingType

Identifies a LineSpacingType value.

LineSpacingTypeAuto

Identifies a LineSpacingTypeAuto value.

LineStyle

Identifies a LineStyle value.

ListItemType

Identifies a ListItemType value.

MailMergeCleanupOptions

Specifies cleanup operations applied after a mail merge.

MailMergeDiagnosticSeverity

Specifies the severity of a mail-merge diagnostic.

MailMergeEmptyRegionBehavior

Specifies how a missing or empty repeating region is rendered.

MailMergeInvalidValueBehavior

Specifies how a field-value conversion failure is handled.

MailMergeMissingFieldBehavior

Specifies how a missing scalar merge field is rendered.

MailMergeMissingImageBehavior

Specifies behavior when an image field has no usable image source.

MailMergeNullValueBehavior

Specifies how a scalar merge field with a null value is rendered.

MailMergeTextEscaping

Specifies escaping applied to formatted mail-merge text.

MatchFormattingOptions

Identifies a MatchFormattingOptions value.

MathObjectType

Identifies the OMML container used by an office math object.

MeasurementUnit

Identifies the unit used by a document measurement.

MsWordVersion

Identifies the Microsoft Word compatibility version requested for a document.

NodeType

Identifies a NodeType value.

NumberStyle

Identifies a NumberStyle value.

OfficeMathDisplayType

Specifies whether an office math object is displayed inline or as a separate block.

OfficeMathJustification

Specifies the horizontal justification of a display office math object.

OleObjectType

Identifies a OleObjectType value.

Orientation

Identifies a Orientation value.

OutlineLevel

Specifies the outline level of a paragraph, matching the Word paragraph "Outline level" setting. Maps to w:outlineLvl.

PageBorderAppliesTo

Specifies which pages the page border is printed on.

PageBorderDistanceFrom

Identifies a PageBorderDistanceFrom value.

PageNumberFormat

Identifies a PageNumberFormat value.

PageSplitOverflowMode

Specifies how page extraction handles a node whose layout crosses a page boundary.

PageVerticalAlignment

Specifies vertical justification of text on each page.

ParagraphAlignment

Identifies a ParagraphAlignment value.

ReplaceAction

Specifies how a replacing callback should handle a match.

RevisionType

Specifies the type of a tracked change revision.

RevisionsView

Specifies whether a document is viewed before or after tracked changes.

RunTextType

Text types in a Run

Script

Identifies a Script value.

SectionBreakType

Identifies a SectionBreakType value.

SectionLayoutMode

Identifies a SectionLayoutMode value.

SectionStart

Identifies a SectionStart value.

SourceContributorRole

Specifies a contributor's role for a bibliography source.

SourceType

Specifies the publication type of a bibliography source.

StoryType

Identifies a StoryType value.

StrikeThrough

Identifies a StrikeThrough value.

StyleIdentifier

Identifies a built-in Microsoft Word style independently of its localized name.

StyleType

Specifies the category of a document style.

TabAlignment

Specifies the alignment of a tab stop, matching the Word "Tabs" dialog alignment options.

TabLeader

Specifies the leader character drawn in the empty space before a tab stop, matching the Word "Tabs" dialog leader options.

TabStopValues

Identifies a TabStopValues value.

TableBorderType

Table Border Types

TableCellBorderType

Table Cell Border Types source: http://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing.tablecellborders.aspx

TableStyleValue

Designs\Styles that can be applied to a table.

TextEffect

Identifies a TextEffect value.

TextOrientation

Specifies orientation of text on a page, in a table cell or a text frame.

TextureIndex

Identifies a TextureIndex value.

TxtLeadingSpacesOptions

Specifies how leading spaces are handled when importing plain text.

TxtTrailingSpacesOptions

Specifies how trailing spaces are handled when importing plain text.

Underline

Identifies a Underline value.

UnderlineStyle

Identifies a UnderlineStyle value.

VerticalAlignment

Identifies a VerticalAlignment value.

ViewType

Identifies the document view used by Word when the document is opened.

VisitorAction

Controls how a DocumentVisitor continues traversal.

XAdESType

XAdES signature level for DOCX digital signatures.

XmlDocument

Identifies a XmlDocument value.

ZoomType

Identifies the automatic zoom behavior used by a document view.

Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX