Back to Devexpress

DevExpress.XtraRichEdit.API.Native Namespace

officefileapi-devexpress-dot-xtrarichedit-dot-api-f3b808d7.md

latest53.3 KB
Original Source

DevExpress.XtraRichEdit.API.Native Namespace

Contains classes which implement the native API of the RichEdit suite.

Assemblies : DevExpress.Docs.v25.2.dll, DevExpress.RichEdit.v25.2.Core.dll

NuGet Packages : DevExpress.Document.Processor, DevExpress.RichEdit.Core

Classes

NameDescription
CompareDocumentOptionsContains options used to compare two documents.
CustomHyphenationDictionaryRepresents a custom hyphenation dictionary.
DocumentBookmarkBase class for bookmark start and end elements.
DocumentBookmarkEndA document element that is the bookmark’s end accessed by DocumentIterator.
DocumentBookmarkStartA document element that is the bookmark’s start accessed by DocumentIterator.
DocumentCheckBoxA document element that is the checkbox accessed by DocumentIterator.
DocumentCommentElementBase class for comment start and end elements.
DocumentCommentEndA document element that indicates the end of the commented range accessed by DocumentIterator.
DocumentCommentStartA document element that indicates the start of the commented range accessed by DocumentIterator.
DocumentElementBaseBase class for all document elements accessed by DocumentIterator.
DocumentEndnoteCustomMarkA document element that indicates an endnote reference with a custom mark.
DocumentEndnoteEmptyReferenceA document element that indicates an empty endnote reference.
DocumentEndnoteReferenceA document element that indicates an endnote reference.
DocumentFieldCodeEndA document element that indicates the end of the field code range accessed by DocumentIterator.
DocumentFieldCodeStartA document element that indicates the start of the field code range accessed by DocumentIterator.
DocumentFieldResultEndA document element that indicates the end of the field result range accessed by DocumentIterator.
DocumentFootnoteCustomMarkA document element that indicates a footnote reference with a custom mark.
DocumentFootnoteEmptyReferenceA document element that indicates an empty footnote reference.
DocumentFootnoteReferenceA document element that indicates an footnote reference.
DocumentFormFieldBaseBase class for all document from field elements accessed by DocumentIterator.
DocumentHyperlinkBase class for hyperlink start and end elements.
DocumentHyperlinkEndA document element that is the hyperlink’s end accessed by DocumentIterator.
DocumentHyperlinkStartA document element that is the hyperlink’s end accessed by DocumentIterator.
DocumentImageSourceContains static methods used to create an image from various sources.
DocumentInlinePictureA document element that is the inline picture accessed by DocumentIterator.
DocumentIteratorIterates over document elements.
DocumentParagraphEndA document element that is the paragraph’s end accessed by DocumentIterator.
DocumentParagraphStartA document element that indicates the paragraph’s start accessed by DocumentIterator.
DocumentPictureA document element that is the floating picture accessed by DocumentIterator.
DocumentPositionA position within a document.
DocumentRangeExtensions staticDefines extension methods for the DocumentRange interface.
DocumentRangePermissionEndA document element that indicates the end of the range permission accessed by DocumentIterator.
DocumentRangePermissionStartA document element that indicates the start of the range permission accessed by DocumentIterator.
DocumentSectionEndA document element that is the section’s end accessed by DocumentIterator.
DocumentSectionStartA document element that indicates the section start accessed by DocumentIterator.
DocumentTableCellBorderA document element that indicates a table cell border accessed by DocumentIterator.
DocumentTextDocument element that is a group of characters with the same format accessed by DocumentIterator
DocumentTextBoxDocument element that is a text box accessed by the DocumentIterator.
DocumentThemeRepresents a document theme.
DocumentVisitorBaseA base class implementing the IDocumentVisitor interface.
EncryptionSettingsBase implementation of the DocumentEncryption interface.
FixedRangeCombines start and length of the document range. Used in Layout API.
HyphenationDictionaryBaseServes as a base for the hyphenation dictionary classes.
ImageWatermarkOptionsContains watermark options.
MergeFieldNameMaps a data source field name and its display name for use in a bar or Ribbon editor UI.
OleObjectType staticContains strings used to specify content types for OLE objects.
OpenOfficeHyphenationDictionaryAn OpenOffice hyphenation dictionary.
ParagraphA document paragraph.
RangePermissionRepresents a document range for which editing permissions are set.
RangePermissionCollectionRepresents a collection of range permission in the current document.
ReadOnlyTableCellBorderPropertiesRepresents the table cell border properties accessed by the DocumentIterator.
SectionColumnAn individual column in the layout.
SectionColumnCollectionRepresents a collection of columns in the layout.
SelectionCollectionA collection of selections in the document.
SyntaxHighlightPropertiesContains format settings for a token.
SyntaxHighlightTokenA range of text with format settings.
TabInfoA tab stop.
TabInfoCollectionA collection of tab stops.
TextWatermarkOptionsContains text watermark options.

Interfaces

NameDescription
AbstractNumberingListServes as a pattern for numbered and bulleted lists to define their appearance.
AbstractNumberingListCollectionA collection of AbstractNumberingList objects.
ActiveXFormatContains ActiveX control characteristics.
BookmarkDefines a bookmark in the document.
BookmarkCollectionAn interface that defines a collection of Bookmark objects.
CanvasShapeCollectionA collection of shapes in a drawing canvas.
CaptureRepresents the part of string matched by the group expression (the string matched by a subexpression of group expression).
CaptureCollectionRepresents a sequence of captured substrings as the set of captures executed by a single capturing group.
CharacterPropertiesProvides access to character properties.
CharacterPropertiesBaseServes as the base for the CharacterProperties interface providing access to character properties.
CharacterStyleExposes methods and characteristics of a character style in a document.
CharacterStyleCollectionRepresents a collection of character styles.
ChartFormatContains chart properties.
CheckBoxAn interface implementing the check box functionality.
CommentA comment in the document - a text note that is attached to a DocumentRange.
CommentCollectionA collection of Comment objects.
CompatibilitySettingsEnables you to specify application-wide settings to ensure compatibility with previous versions of rich text editors.
ConnectorFormatContains connector settings.
ContentControlBaseExposes basic members for content controls.
ContentControlBuildingBlockGalleryBuilding block gallery content control.
ContentControlCheckboxCheckbox content control.
ContentControlCollectionA collection of content controls in a document.
ContentControlComboBoxCombo box content control.
ContentControlDateDate picker content control.
ContentControlDropDownListDrop-down list content control.
ContentControlListBaseExposes base members for combo box and drop-down list content controls.
ContentControlListItemExposes members for an item in a combo box and a drop-down list.
ContentControlPicturePicture content control.
ContentControlPlainTextPlain text content control.
ContentControlRepeatingSectionRepeating section content control.
ContentControlRepeatingSectionItemExposes members for an item in the repeating section content control.
ContentControlRichTextRich text content control.
CustomMarkRepresents a custom mark in the document.
CustomMarkCollectionRepresents a collection of custom marks in the document.
CustomXmlPartCollectionA collection of custom XML parts in a document.
DocumentAn interface that exposes the specific functionality of the document.
DocumentCustomPropertiesContains all the custom document properties for the document.
DocumentEncryptionProvides the document encryption options.
DocumentImageDefines an image in the document.
DocumentImageCollectionA collection of DocumentImage objects.
DocumentPropertiesContains core properties of the document.
DocumentRangeDefines a document range.
DocumentTrackChangesOptionsProvides the document Track Changes options.
DrawingObjectA base interface for drawing objects.
EndnoteOptionsContains endnote options.
FieldA document field.
FieldCollectionA collection of document fields.
FootnoteOptionsContains footnote options.
FormFieldAn interface implementing the form fields functionality.
FormFieldCollectionThe collection of FormField objects.
GradientFillContains gradient fill settings.
GradientStopCollectionA collection of gradient stops.
GroupRepresents the results from a single capturing group.
GroupCollectionRepresents character groups matched by the pattern.
GroupShapeCollectionA collection of shapes in a group.
HyperlinkDefines a hyperlink in the document.
HyperlinkCollectionAn interface that defines a collection of Hyperlink objects.
ICustomXmlPartA custom XML part embedded in a document.
IDocumentElementBase interface for all document elements.
IDocumentThemeBase interface for a document theme.
IDocumentVisitorInterface implementing the Visitor pattern.
IHyphenationDictionaryDefines a hyphenation dictionary.
IRegexSearchResultDefines the interface used for text searching, using regular expressions.
ISearchResultDefines the interface used for text searching.
LineFillFormatContains fill settings for a line or a shape’s border.
ListLevelRepresent a list level in a numbered or bulleted list.
ListLevelPropertiesBase class for the ListLevel. Provides basic level properties.
MailMergeOptionsDefines mail merge options for a specific merge process.
MailMergeRegionInfoExposes members used to obtain information about the mail merge region.
MatchRepresents the result of a regular expression matching operation.
MergeFieldA mail merge field.
NestedShapeA shape that belongs to a group or drawing canvas.
NestedShapeCollectionA base interface for collections that store nested shapes.
NoteRepresents a document note (footnote or endnote).
NoteCollectionA collection of Note objects.
NumberingListA numbering definition instance referenced by paragraphs in a document that comprises a numbering list.
NumberingListBaseBase interface for numbering lists.
NumberingListCollectionA collection of numbering definition instances.
ObjectFormatBaseA base interface for the OleFormat and ActiveXFormat interfaces.
OleFormatContains OLE object characteristics.
OlePackageContains OLE Package properties.
OverrideListLevelProvides override options for the ListLevel class.
PageBorderImplements members used to specify page border settings.
ParagraphBorderImplements members used to specify paragraph border parameters.
ParagraphBordersContains paragraph border settings.
ParagraphCollectionAn interface that defines a collection of Paragraph objects.
ParagraphPropertiesContains paragraph properties.
ParagraphPropertiesBaseServes as the base for the ParagraphProperties interface, obtaining paragraph properties.
ParagraphPropertiesWithTabsInterface derived from the ParagraphPropertiesBase to include methods for specifying tab stops within a paragraph.
ParagraphStyleExposes methods and characteristics of a paragraph style in a document.
ParagraphStyleCollectionRepresents a collection of paragraph styles.
PatternFillContains pattern fill settings.
PictureFillContains picture fill settings.
PictureFormatContains picture settings.
ReadOnlyBookmarkCollectionA collection of Bookmark objects in the document.
ReadOnlyCheckBoxPropertiesAn interface implementing the checkbox properties accessed by the DocumentIterator.
ReadOnlyCommentCollectionA collection of comments (Comment objects) in the document.
ReadOnlyCustomMarkCollectionA collection of CustomMark objects in the document.
ReadOnlyDocumentBuiltInPropertiesImplements the built-in document properties retrieved by the RichEditDocumentServerExtensions.LoadDocumentProperties method.
ReadOnlyDocumentCustomPropertiesImplements the custom document properties the RichEditDocumentServerExtensions.LoadDocumentProperties method retrieves.
ReadOnlyDocumentImageCollectionA read-only collection of document images (DocumentImage objects).
ReadOnlyDocumentPropertiesImplements the document properties retrieved by the RichEditDocumentServerExtensions.LoadDocumentProperties method.
ReadOnlyEndnoteOptionsAn interface implementing the endnote options accessed by the DocumentIterator.
ReadOnlyFieldCollectionA collection of Field objects in the document.
ReadOnlyFootnoteOptionsAn interface implementing the footnote options accessed by the DocumentIterator.
ReadOnlyFormFieldPropertiesAn interface implementing the form field properties accessed by the DocumentIterator.
ReadOnlyHyperlinkCollectionA collection of Hyperlink objects in the document.
ReadOnlyPageBorderImplements the read-only page border properties accessible by the DocumentIterator object.
ReadOnlyParagraphBorderImplements the read-only paragraph border properties accessible by the DocumentIterator object.
ReadOnlyParagraphBordersExposes members used to obtain paragraph borders.
ReadOnlyParagraphCollectionA collection of paragraphs (Paragraph objects) in the document.
ReadOnlyParagraphPropertiesInterface implementing the paragraph properties accessed by the DocumentIterator.
ReadOnlyParagraphPropertiesBaseBase interface for all paragraph properties accessed by the DocumentIterator.
ReadOnlyParagraphStyleAn interface implementing the paragraph style properties accessed by the DocumentIterator.
ReadOnlySectionLineNumberingAn interface implementing the line numbering properties of a document section accessed by the DocumentIterator.
ReadOnlySectionMarginsAn interface implementing the margin options of a document section accessed by the DocumentIterator.
ReadOnlySectionPageAn interface implementing page settings of a document section accessed by the DocumentIterator.
ReadOnlySectionPageBordersExposes members used to obtain page borders.
ReadOnlySectionPageNumberingAn interface implementing the page numbering setting of a document section accessed by the DocumentIterator.
ReadOnlySectionsPropertiesAn interface implementing the section properties accessed by the DocumentIterator.
ReadOnlyShapeCollectionA collection of shapes (Shape objects) in the document.
ReadOnlyTableCollectionA collection of tables (Table objects) in the document.
ReadOnlyTextPropertiesAn interface implementing the text properties accessed by the DocumentIterator.
ReadOnlyTextPropertiesBaseBase interface for all text properties accessed by the DocumentIterator.
RevisionRepresents a revision made in the document.
RevisionCollectionA collection of Revision objects.
SectionAn interface that defines a section within a document.
SectionCollectionAn interface that defines a collection of Section objects.
SectionColumnsRepresents an interface for creating, applying and retrieving a column layout of a section in a document.
SectionLineNumberingDefines line numbers in the left margin or to the left of each column in the document’s Section.
SectionMarginsProvides access to the properties of margins in a Section.
SectionPageProvides access to the page settings of a section.
SectionPageBordersProvides access to page border settings in a Section.
SectionPageNumberingExposes members used to specify page numbering options.
ShapeA drawing object embedded in a document.
ShapeCollectionA collection of drawing objects (shapes, pictures, text boxes, charts, watermarks, OLE objects, and ActiveX controls).
ShapeConnectionPointContains information about connection points.
ShapeFillContains fill settings for a shape.
ShapeFormatContains shape properties.
ShapeLineContains format settings for a line or a shape’s border.
SolidFillContains solid fill options.
SubDocumentExposes properties and methods representing essential document functionality.
TableRepresents a single table.
TableBorderThe border characteristics of a table.
TableBordersContains characteristics for table borders.
TableCellRepresents a single table cell.
TableCellBorderThe border characteristics of a cell.
TableCellBordersContains characteristics for cell borders.
TableCellCollectionA collection of TableCell objects in a table row.
TableCellPropertiesBaseContainer for table characteristics used to specify table cell characteristics for table styles.
TableCollectionA collection of Table objects in a document.
TableConditionalStyleA style that can be applied to table elements which meet a certain condition.
TableConditionalStylePropertiesA container that holds conditional styles for the table and enables you to create new conditional styles.
TablePropertiesBaseContainer for table characteristics used to specify default table properties and table style characteristics.
TableRowRepresents a row in a table.
TableRowCollectionA collection of TableRow objects that is the table rows in a table.
TableStyleA table style.
TableStyleCollectionA collection of table styles.
TemplateAbstractNumberingListDefines the template used for creating abstract numbering lists in a document.
TextBoxDefines text box content and its settings.
VbaModuleExposes members used to obtain information on a module in a VBA project.
VbaModuleCollectionA collection of VBA project modules.’
VbaProjectExposes members used to obtain information on the VBA project in a macro-enabled document.
WatermarkFormatContains watermark settings.
WatermarkManagerManages document watermarks.

Structs

NameDescription
GradientStopDefines the color and position of a transition point in a gradient.
RectangleOffsetDefines offsets from the shape edges.

Delegates

NameDescription
TableCellProcessorDelegateA delegate intended to invoke its method for each cell in a table.
TableRowProcessorDelegateA delegate intended to invoke its method for each row in a table.

Enums

NameDescription
ActiveXControlTypeLists ActiveX control types.
AutoFitBehaviorTypeLists AutoFit layout algorithm types.
BorderLineStyleList values that indicate border style.
CharacterPropertiesMaskLists the value masks available for character properties.
ChartTypeLists chart types.
CheckBoxSizeModeLists the size modes available for the CheckBox object.
CheckBoxStateLists states available for the check box.
ComparisonLevelLists values that indicate the document comparison level.
ComparisonTargetTypeLists values that indicate where to load the document with Track Changes after comparison.
CompatibilityModeLists modes that specify the compatibility of the document being exported with different Microsoft Word versions.
ConditionalTableStyleFormattingTypesLists table elements to which a style should be applied.
ConnectorTypeLists connector types.
ContentControlAppearanceTypeLists values that indicate the content control’s appearance type.
ContentControlTypeLists values that indicate the content control type.
DocumentElementTypeLists types of document elements accessed by DocumentIterator.
DocumentProtectionTypeLists the types of protection that can be applied to the current document.
EncryptionTypeLists available encryption types for a document.
EndnotePositionLists values used to specify the endnotes position in the document.
FillTypeLists values that specify how a shape is filled.
FootnotePositionLists values used to specify the endnotes position in the document.
FormFieldTextTypeLists types of help text associated with the form field.
FormFieldTypeLists the types of form fields.
GradientTypeLists gradient types.
GutterPositionLists values that indicate the gutter margin position.
HeaderFooterTypeLists the header (footer) types.
HeightTypeLists the meaning of the height specified for the container object.
InsertOptionsLists options specifying how formatting is applied to the formatted text inserted into a document.
LineAlignmentLists values that specify the alignment of a border line relative to a shape.
LineArrowSizeLists values used to specify an arrowhead’s width and length.
LineArrowTypeLists values that specify the arrowhead type.
LineCapTypeLists values used to specify the cap type for line ends.
LineCompoundTypeLists values that specify the compound line type.
LineDashTypeLists values that specify the line dash type.
LineJoinTypeLists values that specify the line join type.
LineNumberingRestartLists conditions for the line numbering to revert to the start value.
MailMergeNumberingRestartList types of the behavior of numbered lists when the mail merge operation is performed.
MarginTypeLists values that indicate the margin type.
MergeModeLists delimiters that start the new merged range.
NoteRestartTypeLists conditions for the notes numbering to reset to the start value.
NoteSeparatorTypeLists values used to indicate the note separator types.
NumberingFormatSpecifies the numbering format used for a group of automatically numbered objects, such as pages.
NumberingTypeLists possible types of a numbering list.
OleInsertTypeLists values that specify how an OLE object is inserted into the document.
OleObjectRepresentationTypeLists values that specify how an OLE object is displayed in the document.
PageBorderAppliesToLists values that specify which pages in the section display borders.
PageBorderOffsetFromLists options used to measure page border offset.
PageBorderZOrderSpecifies the z-order position of the page border.
ParagraphAlignmentSpecifies a paragraph alignment.
ParagraphFirstLineIndentSpecifies the indent for the first line in a paragraph.
ParagraphLineSpacingSpecifies the way to determine the spacing between lines in a paragraph
ParagraphPropertiesMaskLists the value masks available for paragraph properties.
PatternFillTypeLists preset patterns for a pattern fill.
RevisionTypeLists values used to indicate the revision type.
SearchDirectionList search directions.
SearchOptionsLists options used for searching.
SectionStartTypeLists the types of a section break.
ShapeGeometryPresetLists values that specify the shape geometry type.
ShapeHorizontalAlignmentLists values that specify the horizontal alignment for a shape.
ShapeRelativeHorizontalPositionLists elements to which the horizontal position of a shape is relative.
ShapeRelativeHorizontalSizeLists elements to which the shape width is relative.
ShapeRelativeVerticalPositionLists elements to which the vertical position of a shape is relative.
ShapeRelativeVerticalSizeLists elements to which the shape height is relative.
ShapeTypeLists graphical objects a document can contain.
ShapeVerticalAlignmentLists values that specify the vertical alignment for a shape.
StrikeoutTypeLists strikeout styles.
SubDocumentTypeLists subdocument types.
TabAlignmentTypeList alignment types for tab stops.
TabLeaderTypeLists repeated characters used to fill in the space created by a tab which ends at the tab stop.
TableCellPropertiesMaskLists the value masks available for table cell properties.
TableCellVerticalAlignmentLists possible vertical alignments for cell content.
TableHorizontalAlignmentLists values used to specify the table horizontal alignment.
TableLayoutTypeLists algorithms which shall be used to lay out the contents of a table within the document.
TableLookTypesLists values used to specify table style options influencing a table appearance.
TablePropertiesMaskLists the value masks available for table cell properties.
TableRelativeHorizontalPositionLists values used to specify elements to which the table horizontal position is relative.
TableRelativeVerticalPositionLists values used to specify elements to which the table vertical position is relative.
TableRowAlignmentLists alignments allowed for the table row.
TableTextWrappingTypeLists values used to specify the type of text wrapping around a table.
TableVerticalAlignmentLists values used to specify a table’s vertical alignment.
TextBoxSizeRuleSpecifies the rule that determines the text box height.
TextDirectionLists values that specify content direction in table cells.
TextWrappingSideLists values that specify how the text wraps around the shape’s sides.
TextWrappingTypeLists values that specify how a shape is surrounded by text.
ThemeFontSpecifies theme fonts used to format characters.
TileAlignTypeLists values that specify how the first tile is positioned relative to a shape with the texture fill.
TileFlipTypeLists values that specify how to flip tiles when a texture fill is applied to a shape.
UnderlineTypeLists underline styles.
VerticalMergingStateLists values characterizing a cell regarding a vertical merge.
VerticalTextAlignmentTypeLists values that specify the vertical alignment of text box content.
WatermarkLayoutLists values that specify the text watermark layout type.
WatermarkTypeLists values that indicate the document watermark type.
WidthTypeSpecifies how RichEditControl interprets the specified width (length).