The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V19.1
19.2 (EAP/Beta)
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

EditingField Class

Provides functionality for a field whose content can be edited in the Web Document Viewer.

Declaration

class EditingField

Properties

editValue Property

Specifies the current value of an editing field.

Declaration

editValue: ko.Computed<any>

Property Value

Type Description
ko.Computed<any>

The editing field's current value.

readOnly Property

Specifies whether an editing field's content can be customized in Print Preview.

Declaration

readOnly: ko.Observable<boolean> | ko.Computed<boolean>

Property Value

Type Description
ko.Observable<boolean>
ko.Computed<boolean>

Methods

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.

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.

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.