Back to Devexpress

FieldOptions Members

officefileapi-devexpress-dot-xtrarichedit-dot-fieldoptions-dot-underscore-members.md

latest6.9 KB
Original Source

FieldOptions Members

Contains options used to define the appearance and behavior of the document fields.

Constructors

NameDescription
FieldOptions()Initializes a new instance of the FieldOptions class with the default settings.

Properties

NameDescription
ClearUnhandledDocVariableFieldGets or sets whether the DOCVARIABLE field value is cleared when it cannot be calculated.
HighlightColorGets or sets the color used to highlight the document fields.
HighlightModeGets or sets when the document fields should be highlighted.
ThrowExceptionOnInvalidFormatSwitchGets or sets whether to throw exception if a field formatting switch is not recognized.
UpdateDocVariablesBeforeCopySpecifies whether to refresh the values of document variables when they are to be copied to the Clipboard.
UpdateDocVariablesBeforePrintSpecifies whether to refresh the values of document variables when the document is printed or exported to PDF.
UpdateFieldsInTextBoxesGets or sets whether the FieldCollection.Update method updates fields contained in text boxes.
UpdateFieldsOnPasteGets or sets whether document fields contained in the pasted range should be updated.
UpdateHyperlinksOnLoadGets or sets whether to update hyperlinks without the result text.
UpdateLockedFieldsGets or sets whether locked fields can be updated.
UseCurrentCultureDateTimeFormatGets or sets whether the current culture’s short date and time display settings should be used to format DateTime value for display.

Methods

NameDescription
Assign(BaseOptions)Copies all settings from the options object passed as a parameter. Inherited from BaseOptions.
BeginUpdate()Locks the BaseOptions object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from BaseOptions.
CancelUpdate()Unlocks the BaseOptions object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseOptions.
EndUpdate()Unlocks the BaseOptions object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseOptions.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Reset()Resets all notification options to their default values. Inherited from RichEditNotificationOptions.
ToString()Returns a string representing the currently enabled options. Inherited from BaseOptions.

Events

NameDescription
ChangedOccurs when the options are modified. Inherited from RichEditNotificationOptions.

See Also

FieldOptions Class

DevExpress.XtraRichEdit Namespace