Skip to main content

Class LandingPageTab

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for LandingPageTab. A single tab on a landing page. Depending on TabType it represents a saved selection, an entity record, or a hardcoded provider.

Inheritance

objectCarrierLandingPageTab

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

LandingPageTab()

Default constructor - defaults any enum props to 0.

Properties

EntityType

Table name of the record the tab points at (selection, contact, person, sale, …) for a selection or entity tab; empty for a provider tab.

Property Value

string

Id

Record id the tab points at: the selection id for a selection tab, the entity record id for an entity tab, 0 for a provider tab.

Property Value

int

Name

Display name for the tab. Populated for selection and entity tabs; empty for provider tabs (the client owns provider captions).

Property Value

string

Pinned

True if the tab is pinned; false if it is only open in the working set.

Property Value

bool

ProviderKey

Provider key for a provider tab (e.g. LastTickets, FavouriteTickets); empty for selection and entity tabs.

Property Value

string

Rank

Zero-based position of the tab in the landing page’s tab order.

Property Value

int

TabType

What kind of content the tab shows: a saved selection, a single entity record, or a hardcoded provider. NULL if unknown enum value.

Property Value

LandingPageTabType?

See Also

LandingPageTab.TabType_String

TabType_String

What kind of content the tab shows: a saved selection, a single entity record, or a hardcoded provider. Raw string enum value.

Property Value

string

See Also

LandingPageTab.TabType

See Also

ConfigurationAgent