TabInfo<T> Class

Provides information about a tab available in the Document Viewer.

Declaration

export class TabInfo<T = any> extends BaseRenderingModel<DevExpress.Analytics.Utils.ITabPanelItemViewModel<T>>

Type Parameters

Name
T

Remarks

The following properties return the ASPxClientDocumentPreviewTab object:

Properties

active Property

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

Declaration

active: boolean

Property Value

Type
boolean

collapsed Property

Declaration

collapsed: boolean

Property Value

Type
boolean

disabled Property

Declaration

disabled: boolean

Property Value

Type
boolean

imageClassName Property

Provides access to the CSS class of the tab’s icon.

Declaration

imageClassName: string

Property Value

Type	Description
string	The name of the CSS class.

imageTemplateName Property

Provides access to the HTML template of the tab’s icon.

Declaration

imageTemplateName: string

Property Value

Type	Description
string	The name of the HTML template.

model Property

Provides access to a tab model.

Declaration

model: any

Property Value

Type	Description
any	The tab model.

name Property

Declaration

name: string

Property Value

Type
string

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

get text(): string

Property Value

Type	Description
string	The tab text.

visible Property

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

Declaration

visible: boolean

Property Value

Type
boolean

Methods

createViewModel Method

Declaration

createViewModel(): DevExpress.Analytics.Utils.ITabPanelItemViewModel<T>

Returns

Type
ITabPanelItemViewModel<T>

focus Method

Declaration

focus(): void

onPropertyChanged(args) Method

Declaration

onPropertyChanged(
    args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs
): void

Parameters

Name	Type
args	PropertyChangedEventArgs<any> \| ArrayPropertyChangedEventArgs<any>

updateViewModel(args) Method

Declaration

updateViewModel(
    args: DevExpress.Analytics.Serializer.Native.PropertyChangedEventArgs | DevExpress.Analytics.Serializer.Native.ArrayPropertyChangedEventArgs
): void

Parameters

Name	Type
args	PropertyChangedEventArgs<any> \| ArrayPropertyChangedEventArgs<any>