TabInfo Class

Provides information about a tab available in the Document Viewer.

Declaration

export class TabInfo extends Disposable

Remarks

The ASPxClientDocumentPreviewTab object is returned by the following properties:

Properties

active Property

Provides access to the value that specifies whether a tab is active.

Declaration

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

Property Value

Type
Observable<boolean>
Computed<boolean>

collapsed Property

Declaration

collapsed: ko.Subscribable<boolean>

Property Value

Type
Subscribable<boolean>

disabled Property

Declaration

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

Property Value

Type
Observable<boolean>
Computed<boolean>

imageClassName Property

Declaration

imageClassName: ko.Observable<string> | ko.Computed<string>

Property Value

Type
Observable<string>
Computed<string>

imageTemplateName Property

Declaration

imageTemplateName: string

Property Value

Type
string

keyboardHelper Property

Declaration

keyboardHelper: AccessibilityKeyboardHelperBase

Property Value

Type
AccessibilityKeyboardHelperBase

model Property

Provides access to a tab model.

Declaration

model: any

Property Value

Type Description
any

The tab model.

template Property

Provides access to the name of an HTML template used by a tab.

Declaration

template: string

Property Value

Type Description
string

The name of the HTML template used by the tab.

text Property

Provides access to the tab text.

Declaration

readonly text: any

Property Value

Type Description
any

The tab text.

visible Property

Provides access to the value that specifies whether a tab is visible.

Declaration

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

Property Value

Type
Observable<boolean>
Computed<boolean>

Methods

focus Method

Declaration

focus(): void