[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Collapse]Cross-Platform Core Libraries
 [Expand]DevExpress ORM Tool
 [Expand]DevExpress Data Library
 [Expand]DevExpress Pivot Grid Core Library
 [Expand]Miscellaneous
 [Collapse]API Reference
  [Expand]DevExpress.Data
  [Expand]DevExpress.Data.Browsing
  [Expand]DevExpress.Data.Browsing.Design
  [Expand]DevExpress.Data.Camera
  [Expand]DevExpress.Data.Controls
  [Expand]DevExpress.Data.Controls.ExpressionEditor
  [Expand]DevExpress.Data.Entity
  [Expand]DevExpress.Data.Filtering
  [Expand]DevExpress.Data.Filtering.Exceptions
  [Expand]DevExpress.Data.Filtering.Helpers
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Data.ODataLinq
  [Expand]DevExpress.Data.PivotGrid
  [Expand]DevExpress.Data.PLinq
  [Expand]DevExpress.Data.TreeList
  [Expand]DevExpress.Data.Utils
  [Expand]DevExpress.Data.Utils.ServiceModel
  [Expand]DevExpress.Data.WcfLinq
  [Expand]DevExpress.Data.WizardFramework
  [Expand]DevExpress.Data.XtraReports.DataProviders
  [Expand]DevExpress.Data.XtraReports.Labels
  [Expand]DevExpress.Data.XtraReports.ServiceModel
  [Expand]DevExpress.Data.XtraReports.ServiceModel.DataContracts
  [Expand]DevExpress.Data.XtraReports.Wizard
  [Expand]DevExpress.Data.XtraReports.Wizard.Presenters
  [Expand]DevExpress.Data.XtraReports.Wizard.Views
  [Expand]DevExpress.DataAccess
  [Expand]DevExpress.DataAccess.ConnectionParameters
  [Expand]DevExpress.DataAccess.EntityFramework
  [Expand]DevExpress.DataAccess.Excel
  [Expand]DevExpress.DataAccess.ExpressionEditor
  [Expand]DevExpress.DataAccess.Json
  [Expand]DevExpress.DataAccess.Localization
  [Expand]DevExpress.DataAccess.ObjectBinding
  [Expand]DevExpress.DataAccess.Sql
  [Expand]DevExpress.DataAccess.Sql.DataApi
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DataAccess.Web
  [Expand]DevExpress.DataAccess.Wizard
  [Expand]DevExpress.DataAccess.Wizard.Model
  [Expand]DevExpress.DataAccess.Wizard.Presenters
  [Expand]DevExpress.DataAccess.Wizard.Services
  [Expand]DevExpress.DataAccess.Wizard.Views
  [Expand]DevExpress.Diagram.Core
  [Expand]DevExpress.Diagram.Core.Layout
  [Expand]DevExpress.Diagram.Core.Localization
  [Expand]DevExpress.Diagram.Core.Shapes
  [Expand]DevExpress.Diagram.Core.Themes
  [Expand]DevExpress.DocumentServices.ServiceModel
  [Expand]DevExpress.DocumentServices.ServiceModel.Client
  [Expand]DevExpress.DocumentServices.ServiceModel.DataContracts
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.Entity.Model
  [Expand]DevExpress.Entity.ProjectModel
  [Expand]DevExpress.Export
  [Expand]DevExpress.Export.Xl
  [Expand]DevExpress.Map
  [Expand]DevExpress.Mvvm
  [Expand]DevExpress.Mvvm.DataAnnotations
  [Expand]DevExpress.Mvvm.DataModel
  [Expand]DevExpress.Mvvm.ModuleInjection
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.Utils
  [Expand]DevExpress.Mvvm.ViewModel
  [Expand]DevExpress.Office
  [Expand]DevExpress.Office.Crypto
  [Expand]DevExpress.Office.Drawing
  [Expand]DevExpress.Office.Export
  [Expand]DevExpress.Office.Export.Html
  [Expand]DevExpress.Office.Import
  [Expand]DevExpress.Office.Localization
  [Expand]DevExpress.Office.Options
  [Expand]DevExpress.Office.Services
  [Expand]DevExpress.Office.Utils
  [Expand]DevExpress.Pdf
  [Expand]DevExpress.Pdf.Localization
  [Expand]DevExpress.PivotGrid.Printing
  [Expand]DevExpress.Printing
  [Expand]DevExpress.Printing.Core
  [Expand]DevExpress.Printing.ExportHelpers
  [Expand]DevExpress.ReportServer.Printing
  [Expand]DevExpress.ReportServer.Printing.Services
  [Expand]DevExpress.ReportServer.ServiceModel.Client
  [Expand]DevExpress.ReportServer.ServiceModel.ConnectionProviders
  [Expand]DevExpress.ReportServer.ServiceModel.DataContracts
  [Expand]DevExpress.Schedule
  [Expand]DevExpress.Services
  [Expand]DevExpress.Sparkline
  [Expand]DevExpress.Spreadsheet
  [Expand]DevExpress.Spreadsheet.Charts
  [Expand]DevExpress.Spreadsheet.Drawings
  [Expand]DevExpress.Spreadsheet.Export
  [Expand]DevExpress.Spreadsheet.Formulas
  [Expand]DevExpress.Spreadsheet.Functions
  [Expand]DevExpress.TreeMap
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Commands
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Filtering.Internal
  [Expand]DevExpress.Utils.IoC
  [Expand]DevExpress.Utils.Localization
  [Expand]DevExpress.Utils.Serializing.Helpers
  [Expand]DevExpress.WebUtils
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpo
  [Expand]DevExpress.Xpo.DB
  [Expand]DevExpress.Xpo.DB.Exceptions
  [Expand]DevExpress.Xpo.DB.Helpers
  [Expand]DevExpress.Xpo.Exceptions
  [Expand]DevExpress.Xpo.Helpers
  [Expand]DevExpress.Xpo.Metadata
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Localization
  [Expand]DevExpress.XtraCharts.Native
  [Expand]DevExpress.XtraCharts.Printing
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraExport.Csv
  [Expand]DevExpress.XtraGauges.Base
  [Expand]DevExpress.XtraGauges.Core
  [Expand]DevExpress.XtraGauges.Core.Base
  [Expand]DevExpress.XtraGauges.Core.Drawing
  [Expand]DevExpress.XtraGauges.Core.Localization
  [Expand]DevExpress.XtraGauges.Core.Model
  [Expand]DevExpress.XtraGauges.Core.Primitive
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Customization
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPivotGrid.Localization
  [Expand]DevExpress.XtraPivotGrid.Selection
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.BarCode
  [Expand]DevExpress.XtraPrinting.Caching
  [Expand]DevExpress.XtraPrinting.DataNodes
  [Expand]DevExpress.XtraPrinting.Drawing
  [Expand]DevExpress.XtraPrinting.Export
  [Expand]DevExpress.XtraPrinting.Export.Web
  [Expand]DevExpress.XtraPrinting.Localization
  [Expand]DevExpress.XtraPrinting.Native
  [Expand]DevExpress.XtraPrinting.Shape
  [Expand]DevExpress.XtraPrinting.Shape.Native
  [Expand]DevExpress.XtraPrinting.WebClientUIControl.DataContracts
  [Expand]DevExpress.XtraPrinting.XamlExport
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports
  [Expand]DevExpress.XtraReports.Design
  [Expand]DevExpress.XtraReports.Parameters
  [Expand]DevExpress.XtraReports.ReportGeneration
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.API.Layout
  [Collapse]DevExpress.XtraRichEdit.API.Native
   [Expand]AbstractNumberingList Interface
   [Expand]AbstractNumberingListCollection Interface
    AutoFitBehaviorType Enumeration
   [Expand]Bookmark Interface
   [Expand]BookmarkCollection Interface
   [Expand]Capture Interface
   [Expand]CaptureCollection Interface
   [Expand]CharacterProperties Interface
   [Expand]CharacterPropertiesBase Interface
    CharacterPropertiesMask Enumeration
   [Expand]CharacterStyle Interface
   [Expand]CharacterStyleCollection Interface
   [Expand]CheckBox Interface
    CheckBoxSizeMode Enumeration
    CheckBoxState Enumeration
   [Expand]Comment Interface
   [Expand]CommentCollection Interface
    CompatibilityMode Enumeration
   [Expand]CompatibilitySettings Interface
    ConditionalTableStyleFormattingTypes Enumeration
   [Expand]CustomMark Interface
   [Expand]CustomMarkCollection Interface
   [Expand]Document Interface
   [Expand]DocumentBookmark Class
   [Expand]DocumentBookmarkEnd Class
   [Expand]DocumentBookmarkStart Class
   [Expand]DocumentCheckBox Class
   [Expand]DocumentCommentElement Class
   [Expand]DocumentCommentEnd Class
   [Expand]DocumentCommentStart Class
   [Expand]DocumentCustomProperties Interface
   [Expand]DocumentElementBase Class
    DocumentElementType Enumeration
   [Expand]DocumentFieldCodeEnd Class
   [Expand]DocumentFieldCodeStart Class
   [Expand]DocumentFieldResultEnd Class
   [Expand]DocumentFormFieldBase Class
   [Expand]DocumentHyperlink Class
   [Expand]DocumentHyperlinkEnd Class
   [Expand]DocumentHyperlinkStart Class
   [Expand]DocumentImage Interface
   [Expand]DocumentImageCollection Interface
   [Expand]DocumentImageSource Class
   [Expand]DocumentInlinePicture Class
   [Expand]DocumentIterator Class
   [Expand]DocumentParagraphEnd Class
   [Expand]DocumentParagraphStart Class
   [Expand]DocumentPicture Class
   [Expand]DocumentPosition Class
   [Expand]DocumentProperties Interface
    DocumentProtectionType Enumeration
   [Expand]DocumentRange Interface
   [Expand]DocumentRangePermissionEnd Class
   [Expand]DocumentRangePermissionStart Class
   [Expand]DocumentSectionEnd Class
   [Expand]DocumentSectionStart Class
   [Expand]DocumentTableCellBorder Class
   [Expand]DocumentText Class
   [Expand]DocumentTextBox Class
   [Expand]DocumentVisitorBase Class
   [Collapse]Field Interface
     Field Members
    [Expand]Field Properties
    [Expand]Field Methods
   [Expand]FieldCollection Interface
   [Expand]FixedRange Class
   [Expand]FormField Interface
   [Expand]FormFieldCollection Interface
    FormFieldTextType Enumeration
    FormFieldType Enumeration
   [Expand]Group Interface
   [Expand]GroupCollection Interface
    HeaderFooterType Enumeration
    HeightType Enumeration
   [Expand]Hyperlink Interface
   [Expand]HyperlinkCollection Interface
   [Expand]IDocumentElement Interface
   [Expand]IDocumentVisitor Interface
    InsertOptions Enumeration
   [Expand]IRegexSearchResult Interface
   [Expand]ISearchResult Interface
    LineNumberingRestart Enumeration
   [Expand]ListLevel Interface
   [Expand]ListLevelProperties Interface
    MailMergeNumberingRestart Enumeration
   [Expand]MailMergeOptions Interface
   [Expand]Match Interface
   [Expand]MergeFieldName Class
    MergeMode Enumeration
    NumberingFormat Enumeration
   [Expand]NumberingList Interface
   [Expand]NumberingListBase Interface
   [Expand]NumberingListCollection Interface
    NumberingType Enumeration
   [Expand]Paragraph Class
    ParagraphAlignment Enumeration
   [Expand]ParagraphCollection Interface
    ParagraphFirstLineIndent Enumeration
    ParagraphLineSpacing Enumeration
   [Expand]ParagraphProperties Interface
   [Expand]ParagraphPropertiesBase Interface
    ParagraphPropertiesMask Enumeration
   [Expand]ParagraphPropertiesWithTabs Interface
   [Expand]ParagraphStyle Interface
   [Expand]ParagraphStyleCollection Interface
   [Expand]RangePermission Class
   [Expand]RangePermissionCollection Class
   [Expand]ReadOnlyBookmarkCollection Interface
   [Expand]ReadOnlyCheckBoxProperties Interface
   [Expand]ReadOnlyCommentCollection Interface
   [Expand]ReadOnlyCustomMarkCollection Interface
   [Expand]ReadOnlyDocumentImageCollection Interface
   [Expand]ReadOnlyFieldCollection Interface
   [Expand]ReadOnlyFormFieldProperties Interface
   [Expand]ReadOnlyHyperlinkCollection Interface
   [Expand]ReadOnlyParagraphCollection Interface
   [Expand]ReadOnlyParagraphProperties Interface
   [Expand]ReadOnlyParagraphPropertiesBase Interface
   [Expand]ReadOnlyParagraphStyle Interface
   [Expand]ReadOnlySectionLineNumbering Interface
   [Expand]ReadOnlySectionMargins Interface
   [Expand]ReadOnlySectionPage Interface
   [Expand]ReadOnlySectionPageNumbering Interface
   [Expand]ReadOnlySectionsProperties Interface
   [Expand]ReadOnlyShapeCollection Interface
   [Expand]ReadOnlyTableCellBorderProperties Class
   [Expand]ReadOnlyTableCollection Interface
   [Expand]ReadOnlyTextProperties Interface
   [Expand]ReadOnlyTextPropertiesBase Interface
    SearchDirection Enumeration
    SearchOptions Enumeration
   [Expand]Section Interface
   [Expand]SectionCollection Interface
   [Expand]SectionColumn Class
   [Expand]SectionColumnCollection Class
   [Expand]SectionColumns Interface
   [Expand]SectionLineNumbering Interface
   [Expand]SectionMargins Interface
   [Expand]SectionPage Interface
   [Expand]SectionPageNumbering Interface
    SectionStartType Enumeration
   [Expand]SelectionCollection Class
   [Expand]Shape Interface
   [Expand]ShapeCollection Interface
   [Expand]ShapeFill Interface
    ShapeHorizontalAlignment Enumeration
   [Expand]ShapeLine Interface
    ShapeRelativeHorizontalPosition Enumeration
    ShapeRelativeVerticalPosition Enumeration
    ShapeVerticalAlignment Enumeration
    StrikeoutType Enumeration
   [Expand]SubDocument Interface
    SubDocumentType Enumeration
   [Expand]SyntaxHighlightProperties Class
   [Expand]SyntaxHighlightToken Class
    TabAlignmentType Enumeration
   [Expand]TabInfo Class
   [Expand]TabInfoCollection Class
   [Expand]Table Interface
    TabLeaderType Enumeration
   [Expand]TableBorder Interface
    TableBorderLineStyle Enumeration
   [Expand]TableBorders Interface
   [Expand]TableCell Interface
   [Expand]TableCellBorder Interface
   [Expand]TableCellBorders Interface
   [Expand]TableCellCollection Interface
    TableCellProcessorDelegate Delegate
   [Expand]TableCellPropertiesBase Interface
    TableCellPropertiesMask Enumeration
   [Expand]TableCellStyle Interface
   [Expand]TableCellStyleCollection Interface
    TableCellVerticalAlignment Enumeration
   [Expand]TableCollection Interface
   [Expand]TableConditionalStyle Interface
   [Expand]TableConditionalStyleProperties Interface
    TableLayoutType Enumeration
    TableLookTypes Enumeration
   [Expand]TablePropertiesBase Interface
    TablePropertiesMask Enumeration
   [Expand]TableRow Interface
    TableRowAlignment Enumeration
   [Expand]TableRowCollection Interface
    TableRowProcessorDelegate Delegate
   [Expand]TableStyle Interface
   [Expand]TableStyleCollection Interface
   [Expand]TemplateAbstractNumberingList Interface
   [Expand]TextBox Interface
    TextBoxSizeRule Enumeration
    TextWrappingType Enumeration
    UnderlineType Enumeration
    VerticalMergingState Enumeration
    WidthType Enumeration
  [Expand]DevExpress.XtraRichEdit.API.Native.Implementation
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Export.Html
  [Expand]DevExpress.XtraRichEdit.Export.Rtf
  [Expand]DevExpress.XtraRichEdit.Forms
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Services
  [Expand]DevExpress.XtraRichEdit.Utils
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Compatibility
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Exchange
  [Expand]DevExpress.XtraScheduler.iCalendar
  [Expand]DevExpress.XtraScheduler.iCalendar.Components
  [Expand]DevExpress.XtraScheduler.Localization
  [Expand]DevExpress.XtraScheduler.Native
  [Expand]DevExpress.XtraScheduler.Outlook
  [Expand]DevExpress.XtraScheduler.Outlook.Interop
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.Tools
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraScheduler.Xml
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Export
  [Expand]DevExpress.XtraSpreadsheet.Export.Html
  [Expand]DevExpress.XtraSpreadsheet.Import
  [Expand]DevExpress.XtraSpreadsheet.Localization
  [Expand]DevExpress.XtraSpreadsheet.Services
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Field Interface

Represents a field in the document.

Namespace:DevExpress.XtraRichEdit.API.Native
Assembly:DevExpress.RichEdit.v18.2.Core.dll

Expanded Syntax

Expanded Remarks

A field is a set of codes that instructs a RichEditControl to insert text or graphics into a document automatically. The text or graphics inserted into a document when a control processes a field's codes is the field result for that field. The action of processing a field's codes to obtain a field result is called a field update.

A field in the document consists of two ranges - the CodeRange and the ResultRange. The total range that the field occupies is obtained via the Range property.

In the document, either field codes or the field result can be displayed. Use the ShowCodes method to display codes. The Update method calculates and displays the result. You can also use the following commands to display field codes or results: the ToggleFieldCodesCommand command, the ToggleViewMergedDataCommand command, the ShowAllFieldCodesCommand command, ShowAllFieldResultsCommand command.

The fields in the document can be highlighted. Use the RichEditControlOptionsBase.Fields property to specify the color and highlighting mode.

All fields in the document are contained in the FieldCollection, accessible via the SubDocument.Fields property.

Expanded Inheritance Hierarchy

Expanded See Also

Is this topic helpful?​​​​​​​