SnapFieldOptions Members
Maintains the options that define the appearance and behavior of Snap fields.Constructors
| Name | Description |
|---|---|
| SnapFieldOptions() | Initializes a new instance of the SnapFieldOptions class with default settings. |
Properties
| Name | Description |
|---|---|
| ClearUnhandledDocVariableField | Gets or sets whether the DOCVARIABLE field value is cleared when it cannot be calculated. Inherited from FieldOptions. |
| EnableEmptyFieldDataAlias | Enables the application displaying a custom text instead of a blank space if a Snap field receives an empty data source record. |
| FieldSelection | Specifies the mode for selecting Snap fields when clicking them with the mouse. |
| HighlightColor | Gets or sets the color used to highlight the document fields. Inherited from FieldOptions. |
| HighlightMode | Gets or sets when the document fields should be highlighted. Inherited from FieldOptions. |
| ShowChartInfoPanel | Gets or sets whether the Chart Info panel is displayed in a chart element. |
| ThrowExceptionOnInvalidFormatSwitch | Gets or sets whether to throw exception if a field formatting switch is not recognized. Inherited from FieldOptions. |
| UpdateDocVariablesBeforeCopy | Specifies whether to refresh the values of document variables when they are to be copied to the Clipboard. Inherited from FieldOptions. |
| UpdateDocVariablesBeforePrint | Specifies whether to refresh the values of document variables when the document is to be printed. Inherited from FieldOptions. |
| UpdateFieldsInTextBoxes | Gets or sets whether the FieldCollection.Update method updates fields contained in text boxes. Inherited from FieldOptions. |
| UpdateFieldsOnPaste | Gets or sets whether document fields contained in the pasted range should be updated. Inherited from FieldOptions. |
| UpdateHyperlinksOnLoad | Gets or sets whether to update hyperlinks without the result text. Inherited from FieldOptions. |
| UpdateLockedFields | Gets or sets whether locked fields can be updated. Inherited from FieldOptions. |
| UseCurrentCultureDateTimeFormat | Gets or sets whether the current culture’s short date and time display settings should be used to format DateTime value for display. Inherited from FieldOptions. |
Methods
| Name | Description |
|---|---|
| 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) static | Determines 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() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| ReferenceEquals(Object, Object) static | Determines 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
| Name | Description |
|---|---|
| Changed | Occurs when the options are modified. Inherited from RichEditNotificationOptions. |
See Also