VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase Class Reference

Base class for all primary tab controls. More...

Inheritance diagram for VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase:

Static Public Attributes
static readonly DependencyProperty	ItemActionsPropertyNameProperty
	Identifies the ItemActionsPropertyName dependency property.
static readonly DependencyProperty	ItemAlertPropertyNameProperty
	Identifies the ItemAlertPropertyName dependency property.
static readonly DependencyProperty	ItemIconSourcePropertyNameProperty
	Identifies the ItemIconSourcePropertyName dependency property.
Static Public Attributes inherited from VideoOS.Platform.UI.Controls.VideoOSTabControlBase
static readonly DependencyProperty	ContentTemplateProperty
	Identifies the ContentTemplate dependency property.
static readonly DependencyProperty	IsContentBorderVisibleProperty
	Identifies the IsContentBorderVisible dependency property.
static readonly DependencyProperty	IsContentVisibleProperty
	Identifies the IsContentVisible dependency property.
static readonly DependencyProperty	ItemAutomationIdPropertyNameProperty
	Identifies the ItemAutomationIdPropertyName dependency property.
static readonly DependencyProperty	ItemContentTemplatePropertyNameProperty
	Identifies the ItemContentTemplatePropertyName dependency property.
static readonly DependencyProperty	ItemDataPropertyNameProperty
	Identifies the ItemDataPropertyName dependency property.
static readonly RoutedEvent	ItemDragInitiatedEvent
	Identifies the ItemDragInitiated routed event.
static readonly DependencyProperty	ItemIsDraggablePropertyNameProperty
	Identifies the ItemIsDraggablePropertyName dependency property.
static readonly DependencyProperty	ItemIsEnabledPropertyNameProperty
	Identifies the ItemIsEnabledPropertyName dependency property.
static readonly DependencyProperty	ItemSeparatorPlacementProperty
	Identifies the ItemSeparatorPlacement dependency property.
static readonly DependencyProperty	ItemsSourceProperty
	Identifies the ItemsSource dependency property.
static readonly DependencyProperty	ItemTextPropertyNameProperty
	Identifies the ItemTextPropertyName dependency property.
static readonly DependencyProperty	ItemToolTipPropertyNameProperty
	Identifies the ItemToolTipPropertyName dependency property.
static readonly RoutedEvent	SelectedItemChangedEvent
	Identifies the SelectedItemChanged routed event.
static readonly DependencyProperty	SelectedItemProperty
	Identifies the SelectedItem dependency property.

Protected Member Functions
override AutomationPeer	OnCreateAutomationPeer ()

Properties
string	ItemActionsPropertyName [get, set]
	Gets or sets the name of the property on the items (from VideoOSTabControlBase.ItemsSource) which contains the actions associated with the tab item. NOTE: This property is not relevant if the items in VideoOSTabControlBase.ItemsSource are VideoOSTabControlPrimaryItem instances. The property identified by this name must be of type ICollection<VideoOSActionBase>.
string	ItemAlertPropertyName [get, set]
	Gets or sets the name of the property on the items (from VideoOSTabControlBase.ItemsSource) which contains the alert associated with the tab item. NOTE: This property is not relevant if the items in VideoOSTabControlBase.ItemsSource are VideoOSTabControlPrimaryItem instances. The property identified by this name must be of type VideoOSAlert.
string	ItemIconSourcePropertyName [get, set]
	Gets or sets the name of the property on the items (from VideoOSTabControlBase.ItemsSource) which contains the VideoOSIconSourceBase representing the icon of the item. If not set, the item will not show an icon. NOTE: This property is not relevant if the items in VideoOSTabControlBase.ItemsSource are VideoOSTabControlPrimaryItem instances. The property identified by this name must be of type inheriting from VideoOSIconSourceBase. See VideoOSIconSourceBase for more information.
Properties inherited from VideoOS.Platform.UI.Controls.VideoOSTabControlBase
DataTemplate	ContentTemplate [get, set]
	Gets or sets a data template used to visualize the tabs content the tab control. NOTE: If the items in ItemsSource are derived from VideoOSTabControlItemBase, this can be overruled by the VideoOSTabControlItemBase.ContentTemplate property. NOTE: If the items in ItemsSource are not derived from VideoOSTabControlItemBase, this can be overruled by a DataTemplate returned by an item property identified by the name in ItemDataPropertyName. NOTE: If no content data template is set "anywhere" then the tabs content is visualized using a default visualization.
bool	IsContentBorderVisible [get, set]
	Gets or sets a value indicating if the tab control content border is visible or not.
bool	IsContentVisible [get, set]
	Gets or sets a value indicating if the tab control content is visible or not. If false only the tab headers will be displayed. Note that if set to false it will in most cases make sense that IsContentBorderVisible is also set to false.
string	ItemAutomationIdPropertyName [get, set]
	Gets or sets the name of the property on the items (from ItemsSource) which holds the desired System.Windows.Automation.AutomationProperties.AutomationIdProperty that should be applied on the created System.Windows.FrameworkElement. NOTE: This property is not relevant if the items in ItemsSource are derived from VideoOSTabControlItemBase. The property identified by this name must be of type string.
string	ItemContentTemplatePropertyName [get, set]
	Gets or sets the name of the property on the items (from ItemsSource) which contains a DataTemplate that will be used for the visualization of the tab item content. If not set, a built-in template will be used. NOTE: This property is not relevant if the items in ItemsSource are derived from VideoOSTabControlItemBase. The property identified by this name must be of type DataTemplate.
string	ItemDataPropertyName [get, set]
	Gets or sets the name of the property on the items (from ItemsSource) which contains the data associated with the tab item. If set to null (default) then the item it selves will be used. NOTE: This property is not relevant if the items in ItemsSource are derived from VideoOSTabControlItemBase. The property type can be any type and is passed transparently into the FrameworkElement.DataContext of the UI representing the tab item content.
string	ItemIsDraggablePropertyName [get, set]
	Gets or sets the name of the property on the items (from ItemsSource) which indicates if the item is draggable or not. If not set, the item in not draggable. NOTE: This property is not relevant if the items in ItemsSource are derived from VideoOSTabControlItemBase. The property identified by this name must be of type bool.
string	ItemIsEnabledPropertyName [get, set]
	Gets or sets the name of the property on the items (from ItemsSource) which indicates if the item is enabled or not. If not set, the item will be enabled by default. NOTE: This property is not relevant if the items in ItemsSource are derived from VideoOSTabControlItemBase. The property identified by this name must be of type bool.
ItemSeparatorPlacements	ItemSeparatorPlacement [get, set]
	Gets or sets a value indicating the placement of the item tab header separators. Default value is ItemSeparatorPlacements.Between.
ICollection	ItemsSource [get, set]
	Gets or sets a collection of items where each item will be represented as a tab in the tab control. The current items can by changed by modifying the content of this collection.
string	ItemTextPropertyName [get, set]
	Gets or sets the name of the property on the items (from ItemsSource) which contains the text to be displayed in the tab control header for the item. NOTE: This property is not relevant if the items in ItemsSource are derived from VideoOSTabControlItemBase. The property identified by this name must be of type string.
string	ItemToolTipPropertyName [get, set]
	Gets or sets the name of the property on the items (from ItemsSource) which contains the tab tool tip text to be displayed for the item. NOTE: This property is not relevant if the items in ItemsSource are derived from VideoOSTabControlItemBase. The property identified by this name must be of type string.
object	SelectedItem [get, set]
	Gets or sets the item representing the tab that is currently selected in the tab control.

Additional Inherited Members
Public Types inherited from VideoOS.Platform.UI.Controls.VideoOSTabControlBase
enum	ItemSeparatorPlacements {   None = 0 , Between = 1 << 1 , BeforeFirst = 1 << 2 , AfterLast = 1 << 3 ,   All = Between | BeforeFirst | AfterLast }
	Specifies the item tab header separator placement flags. More...
Package Types inherited from VideoOS.Platform.UI.Controls.VideoOSTabControlBase
Package Functions inherited from VideoOS.Platform.UI.Controls.VideoOSTabControlBase
Static Package Attributes inherited from VideoOS.Platform.UI.Controls.VideoOSTabControlBase
Events inherited from VideoOS.Platform.UI.Controls.VideoOSTabControlBase
RoutedEventHandler	ItemDragInitiated [add, remove]
	Signals that an item header drag operation is being initiated by the user using the mouse. Listen for this event and use the DragDrop.DoDragDrop method to start the drag-and-drop operation supported by WPF. The RoutedEventArgs available in the event handler is of the type ItemDragInitiatedEventArgs containing information about associated item.
RoutedEventHandler	SelectedItemChanged [add, remove]
	Signals that the selected item (node) in the tree has changed.

Detailed Description

Base class for all primary tab controls.

Member Function Documentation

OnCreateAutomationPeer()

override AutomationPeer VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase.OnCreateAutomationPeer ( )

inlineprotected

Member Data Documentation

ItemActionsPropertyNameProperty

readonly DependencyProperty VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase.ItemActionsPropertyNameProperty

static

Initial value:

=
            DependencyProperty.Register(nameof(ItemActionsPropertyName), typeof(string), typeof(VideoOSTabControlPrimaryBase),
                new PropertyMetadata(null))

Identifies the ItemActionsPropertyName dependency property.

ItemAlertPropertyNameProperty

readonly DependencyProperty VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase.ItemAlertPropertyNameProperty

static

Initial value:

=
            DependencyProperty.Register(nameof(ItemAlertPropertyName), typeof(string), typeof(VideoOSTabControlPrimaryBase),
                new PropertyMetadata(null))

Identifies the ItemAlertPropertyName dependency property.

ItemIconSourcePropertyNameProperty

readonly DependencyProperty VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase.ItemIconSourcePropertyNameProperty

static

Initial value:

=
            DependencyProperty.Register(nameof(ItemIconSourcePropertyName), typeof(string), typeof(VideoOSTabControlPrimaryBase),
                new PropertyMetadata(null))

Identifies the ItemIconSourcePropertyName dependency property.

Property Documentation

ItemActionsPropertyName

string VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase.ItemActionsPropertyName

getset

Gets or sets the name of the property on the items (from VideoOSTabControlBase.ItemsSource) which contains the actions associated with the tab item.
NOTE: This property is not relevant if the items in VideoOSTabControlBase.ItemsSource are VideoOSTabControlPrimaryItem instances.
The property identified by this name must be of type ICollection<VideoOSActionBase>.

ItemAlertPropertyName

string VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase.ItemAlertPropertyName

getset

Gets or sets the name of the property on the items (from VideoOSTabControlBase.ItemsSource) which contains the alert associated with the tab item.
NOTE: This property is not relevant if the items in VideoOSTabControlBase.ItemsSource are VideoOSTabControlPrimaryItem instances.
The property identified by this name must be of type VideoOSAlert.

ItemIconSourcePropertyName

string VideoOS.Platform.UI.Controls.VideoOSTabControlPrimaryBase.ItemIconSourcePropertyName

getset

Gets or sets the name of the property on the items (from VideoOSTabControlBase.ItemsSource) which contains the VideoOSIconSourceBase representing the icon of the item. If not set, the item will not show an icon.
NOTE: This property is not relevant if the items in VideoOSTabControlBase.ItemsSource are VideoOSTabControlPrimaryItem instances.
The property identified by this name must be of type inheriting from VideoOSIconSourceBase. See VideoOSIconSourceBase for more information.