Back to Devexpress

TabInfo<T> Class

xtrareports-js-devexpress-dot-analytics-dot-utils-dot-tabinfo-1.md

latest3.4 KB
Original Source

TabInfo<T> Class

Provides information about a tab available in the Document Viewer.

Declaration

ts
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

ts
active: boolean

Property Value

Type
boolean

collapsed Property

Declaration

ts
collapsed: boolean

Property Value

Type
boolean

disabled Property

Declaration

ts
disabled: boolean

Property Value

Type
boolean

imageClassName Property

Declaration

ts
imageClassName: string

Property Value

Type
string

imageTemplateName Property

Declaration

ts
imageTemplateName: string

Property Value

Type
string

keyboardHelper Property

Declaration

ts
keyboardHelper: DevExpress.Analytics.Internal.AccessibilityKeyboardHelperBase

Property Value

Type
AccessibilityKeyboardHelperBase

model Property

Provides access to a tab model.

Declaration

ts
model: any

Property Value

TypeDescription
any

The tab model.

|

name Property

Declaration

ts
name: string

Property Value

Type
string

template Property

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

Declaration

ts
template: string

Property Value

TypeDescription
string

The name of the HTML template used by the tab.

|

text Property

Provides access to the tab text.

Declaration

ts
get text(): string

Property Value

TypeDescription
string

The tab text.

|

visible Property

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

Declaration

ts
visible: boolean

Property Value

Type
boolean

Methods

createViewModel Method

Declaration

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

Returns

Type
ITabPanelItemViewModel<T>

focus Method

Declaration

ts
focus(): void

onPropertyChanged(args) Method

Declaration

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

Parameters

NameType
argsPropertyChangedEventArgs<any>

updateViewModel(args) Method

Declaration

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

Parameters

NameType
argsPropertyChangedEventArgs<any>