Class
HubTileBase

Base class for all hub tiles.

Definition

Namespace:Telerik.UI.Xaml.Controls.Primitives

Assembly:Telerik.WinUI.Controls.dll

Syntax:

cs-api-definition
public abstract class HubTileBase : RadControl

Inheritance: objectRadControlHubTileBase

Derived Classes: PictureHubTileRadCustomHubTileRadCycleHubTileRadHexHubTileRadHubTileRadIconHubTileRadSlideHubTile

Inherited Members RadControl.EndVisualStateUpdate(bool, bool)RadControl.UpdateVisualState(bool)RadControl.BeginVisualStateUpdate()RadControl.SetVisualState(string, bool)RadControl.CanUpdateVisualState()RadControl.MeasureOverride(Size)RadControl.ArrangeOverride(Size)RadControl.OnApplyTemplate()RadControl.UnapplyTemplateCore()RadControl.OnIsEnabledChanged(bool, bool)RadControl.OnLoaded()RadControl.CurrentVisualStateRadControl.IsLoadedRadControl.IsLoadingRadControl.IsUnloadedRadControl.WasUnloadedRadControl.IsTemplateApplied

Constructors

HubTileBase()

Initializes a new instance of the HubTileBase class.

Declaration

cs-api-definition
protected HubTileBase()

Fields

BackContentProperty

Identifies the BackContent dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty BackContentProperty

Field Value

DependencyProperty

BackContentTemplateProperty

Identifies the BackContentTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty BackContentTemplateProperty

Field Value

DependencyProperty

CommandParameterProperty

Identifies the CommandParameter dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CommandParameterProperty

Field Value

DependencyProperty

CommandProperty

Identifies the Command dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CommandProperty

Field Value

DependencyProperty

IsFlippedProperty

Identifies the IsFlipped dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsFlippedProperty

Field Value

DependencyProperty

IsFrozenProperty

Identifies the IsFrozen dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsFrozenProperty

Field Value

DependencyProperty

TitleProperty

Identifies the Title dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TitleProperty

Field Value

DependencyProperty

TitleTemplateProperty

Identifies the TitleTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TitleTemplateProperty

Field Value

DependencyProperty

UpdateIntervalProperty

Identifies the UpdateInterval dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty UpdateIntervalProperty

Field Value

DependencyProperty

Properties

BackContent

Gets or sets the back content of the tile. When the back content is set, the tile flips with a swivel animation to its back side and periodically flips between its back and front states.

Declaration

cs-api-definition
public object BackContent { get; set; }

Property Value

object

BackContentTemplate

Gets or sets the DataTemplate that is used to visualize the BackContent property.

Declaration

cs-api-definition
public DataTemplate BackContentTemplate { get; set; }

Property Value

DataTemplate

Command

Gets or sets a command that will be executed when the hub tile is tapped.

Declaration

cs-api-definition
public ICommand Command { get; set; }

Property Value

ICommand

CommandParameter

Gets or sets the command parameter that will be passed to the command assigned to the Command property.

Declaration

cs-api-definition
public object CommandParameter { get; set; }

Property Value

object

IsFlipped

Gets or sets a value indicating whether the control is flipped.

Declaration

cs-api-definition
public bool IsFlipped { get; set; }

Property Value

bool

IsFrozen

Gets or sets a value indicating whether the hub tile is frozen. Freezing a hub tile means that it will cease to periodically update itself. For example when it is off-screen.

Declaration

cs-api-definition
public bool IsFrozen { get; set; }

Property Value

bool

IsPointerOver

Gets a value indicating whether the pointer is currently over the control.

Declaration

cs-api-definition
protected bool IsPointerOver { get; }

Property Value

bool

IsUpdateTimerNeeded

Gets a value indicating whether the update timer used to update the tile's VisualState needs to be started.

Declaration

cs-api-definition
protected virtual bool IsUpdateTimerNeeded { get; }

Property Value

bool

LayoutRoot

Gets the LayoutRoot of the control template.

Declaration

cs-api-definition
protected UIElement LayoutRoot { get; }

Property Value

UIElement

ShouldClip

Gets a value indicating whether a rectangle clip is set on the LayoutRoot.

Declaration

cs-api-definition
protected virtual bool ShouldClip { get; }

Property Value

bool

Title

Gets or sets the Title.

Declaration

cs-api-definition
public object Title { get; set; }

Property Value

object

Remarks

The Title property works similar to the ContentControl.Content property. As it is of type object, there are no restrictions of its value - string, UI element, Panel or etc.

TitleTemplate

Gets or sets the DataTemplate that is used to visualize the Title property.

Declaration

cs-api-definition
public DataTemplate TitleTemplate { get; set; }

Property Value

DataTemplate

UpdateInterval

Gets or sets the UpdateInterval. This interval determines how often the tile will update its visual states when it is not frozen. The default value is new TimeSpan(0, 0, 3)

Declaration

cs-api-definition
public TimeSpan UpdateInterval { get; set; }

Property Value

TimeSpan

Example

xaml
<telerikPrimitives:RadHubTile UpdateInterval="0:0:1"/>

Methods

ApplyTemplateCore()

Resolves the ControlTemplate parts.

Declaration

cs-api-definition
protected override bool ApplyTemplateCore()

Returns

bool

Overrides RadControl.ApplyTemplateCore()

ComposeVisualStateName()

Builds the current visual state for this instance.

Declaration

cs-api-definition
protected override string ComposeVisualStateName()

Returns

string

Overrides RadControl.ComposeVisualStateName()

Finalize()

Finalizes an instance of the HubTileBase class. Cleans up any used resources when the object is destroyed.

Declaration

cs-api-definition
protected override void Finalize()

LoadCore()

Called within the handler of the event. Allows inheritors to provide their specific logic.

Declaration

cs-api-definition
protected override void LoadCore()

Overrides RadControl.LoadCore()

OnBackContentChanged(object, object)

A virtual callback that is called when the BackContent property changes.

Declaration

cs-api-definition
protected virtual void OnBackContentChanged(object newBackContent, object oldBackContent)

Parameters

newBackContent

object

The new BackContent value.

oldBackContent

object

The old BackContent value.

OnBackStateActivated()

This callback is invoked when BackContent is set to a non-null value.

Declaration

cs-api-definition
protected virtual void OnBackStateActivated()

OnBackStateDeactivated()

This callback is invoked when BackContent is set to a null value.

Declaration

cs-api-definition
protected virtual void OnBackStateDeactivated()

OnCreateAutomationPeer()

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

Overrides RadControl.OnCreateAutomationPeer()

OnIsFlippedChanged(bool, bool)

This callback is invoked when IsFlipped is changed.

Declaration

cs-api-definition
protected virtual void OnIsFlippedChanged(bool newValue, bool oldValue)

Parameters

newValue

bool

oldValue

bool

OnPointerEntered(PointerRoutedEventArgs)

Declaration

cs-api-definition
protected override void OnPointerEntered(PointerRoutedEventArgs e)

Parameters

e

PointerRoutedEventArgs

OnPointerExited(PointerRoutedEventArgs)

Declaration

cs-api-definition
protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

e

PointerRoutedEventArgs

OnTapped(TappedRoutedEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnTapped(TappedRoutedEventArgs e)

Parameters

e

TappedRoutedEventArgs

OnTemplateApplied()

Occurs when the method has been called and the template is already successfully applied.

Declaration

cs-api-definition
protected override void OnTemplateApplied()

Overrides RadControl.OnTemplateApplied()

ResetTimer()

A virtual method that resets the timer.

Declaration

cs-api-definition
protected void ResetTimer()

UnloadCore()

Called within the handler of the event. Stops the update timer (if currently running).

Declaration

cs-api-definition
protected override void UnloadCore()

Overrides RadControl.UnloadCore()

Update(bool, bool)

A virtual callback that is called periodically when the tile is not frozen. It can be used to update the tile visual states or other necessary operations.

Declaration

cs-api-definition
protected virtual void Update(bool animate, bool updateIsFlipped)

Parameters

animate

bool

updateIsFlipped

bool

UpdateIsFlipped(bool)

Updates the value of the IsFlipped property.

Declaration

cs-api-definition
protected virtual void UpdateIsFlipped(bool animate)

Parameters

animate

bool

UpdateTimerState()

Checks whether the timer should be running or stopped and updates it accordingly.

Declaration

cs-api-definition
protected void UpdateTimerState()