EditingField<T> Class
Provides functionality for a field whose content can be edited in the Web Document Viewer.
#Declaration
export class EditingField<T = unknown> extends BaseRenderingModel<DevExpress.Reporting.Viewer.Editing.IEditValueContainerViewModel<T>>
#Type Parameters
Name |
---|
T |
#Properties
#brick Property
#Declaration
brick: DevExpress.Reporting.Viewer.Utils.IBrickNode
#Property Value
Type |
---|
IBrick |
#editValue Property
Specifies the current value of an editing field.
#Declaration
editValue: T
#Property Value
Type | Description |
---|---|
T | The editing field’s current value. |
#readOnly Property
Specifies whether an editing field’s content can be customized in Print Preview.
#Declaration
readOnly: boolean
#Property Value
Type |
---|
boolean |
#Methods
#createModel(page, pageWidth, pageHeight, editingFieldsProvider, bounds) Method
#Declaration
createModel(
page: DevExpress.Reporting.Viewer.Internal.PreviewPage,
pageWidth: number,
pageHeight: number,
editingFieldsProvider: () => DevExpress.Reporting.Viewer.Editing.EditingField[],
bounds: DevExpress.Reporting.Viewer.Editing.IBounds
): DevExpress.Reporting.Viewer.Editing.EditingFieldBase
#Parameters
Name | Type |
---|---|
page | Preview |
page |
number |
page |
number |
editing |
() => Editing |
bounds | IBounds |
#Returns
Type |
---|
Editing |
#editorName Method
Specifies the name of an editor used to change a field value in Print Preview.
#Declaration
editorName(): string
#Returns
Type | Description |
---|---|
string | The editor name. |
#Remarks
If the editor name has not been explicitly specified, a standard editor is used to customize an editing field’s content in Print Preview.
#getEditValue Method
#Declaration
getEditValue(): T
#Returns
Type |
---|
T |
#groupID Method
Specifies the ID of a logical group to which an editing field for a check box belongs.
#Declaration
groupID(): string
#Returns
Type | Description |
---|---|
string | The ID of a logical group owning the corresponding check box. |
#Remarks
The group ID defines behavior of check boxes in Print Preview.
- When the group ID is null or empty string value, a check box in Print Preview can be switched either to the “checked” or “unchecked” state independent of other available check boxes.
- Otherwise, the field editor behaves like a radio button, and editors having the same ID belong to a single logical group (i.e., only one option can be selected within a group at a time).
#id Method
Specifies the unique identifier of an editing field.
#Declaration
id(): string
#Returns
Type | Description |
---|---|
string | The editing field’s ID. |
#onPropertyChanged(args) Method
#Declaration
onPropertyChanged(
args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs<EditingField> | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs<EditingField>
): void
#Parameters
Name | Type |
---|---|
args | Property |
#pageIndex Method
Specifies the index of the page on which an editing field is located.
#Declaration
pageIndex(): number
#Returns
Type | Description |
---|---|
number | The page index. |
#setEditValue(newVal) Method
#Declaration
setEditValue(
newVal: T
): void
#Parameters
Name | Type |
---|---|
new |
T |
#updateViewModel(args) Method
#Declaration
updateViewModel(
args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs<EditingField<T>> | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs<EditingField<T>>
): void
#Parameters
Name | Type |
---|---|
args | Property |