Class HubTile

Inheritance

System.Object

HubTile

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class HubTile : Control

Constructors

HubTile()

Declaration

public HubTile()

Fields

HorizontalRotateImageIndex

Declaration

public int HorizontalRotateImageIndex

Field Value

Type
System.Int32

m_BackGroundImageLayout

Declaration

public ImageLayout m_BackGroundImageLayout

Field Value

Type
System.Windows.Forms.ImageLayout

Properties

BackColor

Gets/Sets HubTile BackColor

Declaration

public override Color BackColor { get; set; }

Property Value

Type
System.Drawing.Color

BackgroundImage

Declaration

public override Image BackgroundImage { get; set; }

Property Value

Type
System.Drawing.Image

BackgroundImageLayout

Declaration

public override ImageLayout BackgroundImageLayout { get; }

Property Value

Type
System.Windows.Forms.ImageLayout

Banner

Gets/Sets the tile banner region text layout properties.

Declaration

public TextItem Banner { get; set; }

Property Value

Type
TextItem

BannerColor

Gets/Sets the Banner Region Color of the Tile. It will be applicable for DefaultTile and RotateTile type.

Declaration

public Color BannerColor { get; set; }

Property Value

Type
System.Drawing.Color

BannerHeight

Gets/Sets tile Banner Height

Declaration

public int BannerHeight { get; set; }

Property Value

Type
System.Int32

BannerIcon

Gets/Sets Icon to be displayed in Tile Banner Region, it will be applicable for DefaultTile type.

Declaration

public Image BannerIcon { get; set; }

Property Value

Type
System.Drawing.Image

Body

Gets/Sets HubTile Title layout Properties

Declaration

public TextItem Body { get; set; }

Property Value

Type
TextItem

CustomTextPosition

Gets/Sets Region to display Body Text on HubTile.

Declaration

public Rectangle CustomTextPosition { get; set; }

Property Value

Type
System.Drawing.Rectangle

EnableHoverColor

Gets/Sets whether to enable HubTile Hover border color

Declaration

public bool EnableHoverColor { get; set; }

Property Value

Type
System.Boolean

EnableSelectionMarker

Gets/Sets whether tile SelectionMarker can be drawn

Declaration

public bool EnableSelectionMarker { get; set; }

Property Value

Type
System.Boolean

EnableTileSlideEffect

Gets/Sets whether tile sliding effect can be enabled or not.

Declaration

public bool EnableTileSlideEffect { get; set; }

Property Value

Type
System.Boolean

ExpandOnHover

Gets/Sets whether tile expands on focus or not.

Declaration

public bool ExpandOnHover { get; set; }

Property Value

Type
System.Boolean

Font

Gets/Sets HubTile Font

Declaration

public override Font Font { get; set; }

Property Value

Type
System.Drawing.Font

Footer

Gets/Sets tile footer region text layout properties.

Declaration

public TextItem Footer { get; set; }

Property Value

Type
TextItem

HoverBorderLength

Gets/Sets the hover border length which will be drawn once Tile is focused.

Declaration

public int HoverBorderLength { get; set; }

Property Value

Type
System.Int32

HoveredBorderColor

Gets/Sets the hover border color which will be drawn once Tile is focused.

Declaration

public Color HoveredBorderColor { get; set; }

Property Value

Type
System.Drawing.Color

ImageIndex

Gets or sets the image index for Image Transition, it will be applicable for Default Tile type.

Declaration

public int ImageIndex { get; set; }

Property Value

Type
System.Int32

ImageList

Gets/Sets ImageList for Image and rotation transition.

Declaration

public ImageList ImageList { get; set; }

Property Value

Type
System.Windows.Forms.ImageList

ImageListAdv

Gets/Sets ImageListAdv for Image and rotation transition.

Declaration

public ImageListAdv ImageListAdv { get; set; }

Property Value

Type
ImageListAdv

ImageSource

Gets/Sets HubTile background image

Declaration

public Image ImageSource { get; set; }

Property Value

Type
System.Drawing.Image

ImageTransitionSpeed

Gets/Sets the speed of Tile Image Transition, it will be applicable for Default Tile type.

Declaration

public int ImageTransitionSpeed { get; set; }

Property Value

Type
System.Int32

IsFrozen

Gets/Sets whether tile Notification can be Frozen or not.

Declaration

public bool IsFrozen { get; set; }

Property Value

Type
System.Boolean

IsSelectionMarked

Gets/Sets whether tile is selection marked or not.

Declaration

public bool IsSelectionMarked { get; set; }

Property Value

Type
System.Boolean

PulseDuration

Gets/sets the pulsing speed of the Tile. It will be applicable only for the PulsingTile type.

Declaration

public int PulseDuration { get; set; }

Property Value

Type
System.Int32

PulseScale

Gets/sets the pulsing scale depth of the Tile. It will be applicable only for the PulsingTile type.

Declaration

public int PulseScale { get; set; }

Property Value

Type
System.Int32

RightToLeft

Declaration

public override RightToLeft RightToLeft { get; set; }

Property Value

Type
System.Windows.Forms.RightToLeft

RotationTransition

Gets/Sets the Rotation transition direction of Tile, it will be applicable for RotateTile type.

Declaration

public TileFlipDirection RotationTransition { get; set; }

Property Value

Type
TileFlipDirection

RotationTransitionSpeed

Gets/Sets the speed of Tile rotation transition, it will be applicable for RotateTile type.

Declaration

public int RotationTransitionSpeed { get; set; }

Property Value

Type
System.Int32

SelectionArrowColor

Gets/Sets HubTile Selection arrow color

Declaration

public Color SelectionArrowColor { get; set; }

Property Value

Type
System.Drawing.Color

SelectionMarkerColor

Gets/Sets Selection Marker Color

Declaration

public Color SelectionMarkerColor { get; set; }

Property Value

Type
System.Drawing.Color

ShowBanner

Gets/Sets tile Banner visibility, which is applicable for Default Tile and Rotate Tile type

Declaration

public bool ShowBanner { get; set; }

Property Value

Type
System.Boolean

ShowBannerIcon

Gets/Sets whether Icon to be displayed in Banner Region or not. It will be applicable for DefaultTile type.

Declaration

public bool ShowBannerIcon { get; set; }

Property Value

Type
System.Boolean

ShowRotateTileBanner

Gets/Sets whether Banner to be displayed or not on Tile, It will be applicable for RotateTile type.

Declaration

public bool ShowRotateTileBanner { get; set; }

Property Value

Type
System.Boolean

SlideTransition

Gets or sets the image flow direction.

Declaration

public TransitionDirection SlideTransition { get; set; }

Property Value

Type
TransitionDirection

SwitchRotateTileBannerVisibility

Gets/Sets whether to switch Rotate Tile Banner Visibility on next image index

Declaration

public bool SwitchRotateTileBannerVisibility { get; set; }

Property Value

Type
System.Boolean

Text

Declaration

public override string Text { get; set; }

Property Value

Type
System.String

TileType

Gets/Sets HubTile Type

Declaration

public HubTileType TileType { get; set; }

Property Value

Type
HubTileType

Title

Gets/Sets tile title region text layout properties.

Declaration

public TextItem Title { get; set; }

Property Value

Type
TextItem

TurnLiveTileOn

Gets or sets whether the Tile Image Transition to be enabled or not, it will be applicable for DefaultTile Type.

Declaration

public bool TurnLiveTileOn { get; set; }

Property Value

Type
System.Boolean

Methods

CreateAccessibilityInstance()

Overrides the AccessibleObject.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Type	Description
System.Windows.Forms.AccessibleObject	The TreeViewAdv that owns the TreeViewAdvAcessibleObject.

OnDrawDefaultAndBannerTile(PaintEventArgs)

To Render Default and BannerTile type

Declaration

protected void OnDrawDefaultAndBannerTile(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	PaintEventArgs

OnDrawPulseTile(PaintEventArgs)

To Render ZoomTile type

Declaration

protected void OnDrawPulseTile(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	PaintEventArgs

OnDrawRotateTile(Graphics)

To Render RotateTile type

Declaration

protected void OnDrawRotateTile(Graphics e)

Parameters

Type	Name	Description
System.Drawing.Graphics	e	PaintEventArgs

OnLostFocus(EventArgs)

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnMouseDown(MouseEventArgs)

HubTile Mouse Down event

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	MouseEventArgs

OnMouseEnter(EventArgs)

HubTile Mouse Enter event

Declaration

protected override void OnMouseEnter(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	EventArgs

OnMouseLeave(EventArgs)

HubTile Mouse Leave event

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	EventArgs

OnMouseUp(MouseEventArgs)

HubTile MouseUp Event

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	MouseEventArgs

OnPaint(PaintEventArgs)

HubTile Paint event

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	PaintEventArgs

OnSizeChanged(EventArgs)

HubTile Size changed event

Declaration

protected override void OnSizeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	EventArgs

OnTextChanged(EventArgs)

Declaration

protected override void OnTextChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

ResetBackColor()

Declaration

public void ResetBackColor()

ResetBackgroundImageLayout()

Declaration

public void ResetBackgroundImageLayout()

ResetBanner()

Declaration

public void ResetBanner()

ResetBannerColor()

Declaration

public void ResetBannerColor()

ResetBannerHeight()

Declaration

public void ResetBannerHeight()

ResetBannerIcon()

Declaration

public void ResetBannerIcon()

ResetBody()

Declaration

public void ResetBody()

ResetCustomTextPosition()

Declaration

public void ResetCustomTextPosition()

ResetEnableHoverColor()

Declaration

public void ResetEnableHoverColor()

ResetEnableSelectionMarker()

Declaration

public void ResetEnableSelectionMarker()

ResetEnableSlideShow()

Declaration

public void ResetEnableSlideShow()

ResetEnableTileSlideEffect()

Declaration

public void ResetEnableTileSlideEffect()

ResetExpandOnHover()

Declaration

public void ResetExpandOnHover()

ResetFont()

Declaration

public void ResetFont()

ResetFooter()

Declaration

public void ResetFooter()

ResetHoverBorderLength()

Declaration

public void ResetHoverBorderLength()

ResetHoveredBorderColor()

Declaration

public void ResetHoveredBorderColor()

ResetHubTileType()

Declaration

public void ResetHubTileType()

ResetImageCollection()

Declaration

public void ResetImageCollection()

ResetImageIndex()

Declaration

public void ResetImageIndex()

ResetImageList()

Declaration

public void ResetImageList()

ResetImageTransitionSpeed()

Declaration

public void ResetImageTransitionSpeed()

ResetIsFrozen()

Declaration

public void ResetIsFrozen()

ResetIsSelectionMarked()

Declaration

public void ResetIsSelectionMarked()

Resetm_ShowRotateTileBanner()

Declaration

public void Resetm_ShowRotateTileBanner()

ResetPulseDuration()

Declaration

public void ResetPulseDuration()

ResetRotationTransition()

Declaration

public void ResetRotationTransition()

ResetRotationTransitionSpeed()

Declaration

public void ResetRotationTransitionSpeed()

ResetSelectionArrowColor()

Declaration

public void ResetSelectionArrowColor()

ResetSelectionMarkerColor()

Declaration

public void ResetSelectionMarkerColor()

ResetShowBanner()

Declaration

public void ResetShowBanner()

ResetShowBannerIcon()

Declaration

public void ResetShowBannerIcon()

ResetSlideTransition()

Declaration

public void ResetSlideTransition()

ResetSwitchRotateTileBannerVisibility()

Declaration

public void ResetSwitchRotateTileBannerVisibility()

ResetTileImage()

Declaration

public void ResetTileImage()

ResetTitle()

Declaration

public void ResetTitle()

ShouldSerializeBackColor()

Declaration

public bool ShouldSerializeBackColor()

Returns

Type
System.Boolean

ShouldSerializeBackgroundImageLayout()

Declaration

public bool ShouldSerializeBackgroundImageLayout()

Returns

Type
System.Boolean

ShouldSerializeBanner()

Declaration

public bool ShouldSerializeBanner()

Returns

Type
System.Boolean

ShouldSerializeBannerColor()

Declaration

public bool ShouldSerializeBannerColor()

Returns

Type
System.Boolean

ShouldSerializeBannerHeight()

Declaration

public bool ShouldSerializeBannerHeight()

Returns

Type
System.Boolean

ShouldSerializeBannerIcon()

Declaration

public bool ShouldSerializeBannerIcon()

Returns

Type
System.Boolean

ShouldSerializeBody()

Declaration

public bool ShouldSerializeBody()

Returns

Type
System.Boolean

ShouldSerializeCustomTextPosition()

Declaration

public bool ShouldSerializeCustomTextPosition()

Returns

Type
System.Boolean

ShouldSerializeEnableHoverColor()

Declaration

public bool ShouldSerializeEnableHoverColor()

Returns

Type
System.Boolean

ShouldSerializeEnableSelectionMarker()

Declaration

public bool ShouldSerializeEnableSelectionMarker()

Returns

Type
System.Boolean

ShouldSerializeEnableSlideShow()

Declaration

public bool ShouldSerializeEnableSlideShow()

Returns

Type
System.Boolean

ShouldSerializeEnableTileSlideEffect()

Declaration

public bool ShouldSerializeEnableTileSlideEffect()

Returns

Type
System.Boolean

ShouldSerializeExpandOnHover()

Declaration

public bool ShouldSerializeExpandOnHover()

Returns

Type
System.Boolean

ShouldSerializeFont()

Declaration

public bool ShouldSerializeFont()

Returns

Type
System.Boolean

ShouldSerializeFooter()

Declaration

public bool ShouldSerializeFooter()

Returns

Type
System.Boolean

ShouldSerializeHoverBorderLength()

Declaration

public bool ShouldSerializeHoverBorderLength()

Returns

Type
System.Boolean

ShouldSerializeHoveredBorderColor()

Declaration

public bool ShouldSerializeHoveredBorderColor()

Returns

Type
System.Boolean

ShouldSerializeHubTileType()

Declaration

public bool ShouldSerializeHubTileType()

Returns

Type
System.Boolean

ShouldSerializeImageCollection()

Declaration

public bool ShouldSerializeImageCollection()

Returns

Type
System.Boolean

ShouldSerializeImageIndex()

Declaration

public bool ShouldSerializeImageIndex()

Returns

Type
System.Boolean

ShouldSerializeImageList()

Declaration

public bool ShouldSerializeImageList()

Returns

Type
System.Boolean

ShouldSerializeImageTransitionSpeed()

Declaration

public bool ShouldSerializeImageTransitionSpeed()

Returns

Type
System.Boolean

ShouldSerializeIsFrozen()

Declaration

public bool ShouldSerializeIsFrozen()

Returns

Type
System.Boolean

ShouldSerializeIsSelectionMarked()

Declaration

public bool ShouldSerializeIsSelectionMarked()

Returns

Type
System.Boolean

ShouldSerializePulseDuration()

Declaration

public bool ShouldSerializePulseDuration()

Returns

Type
System.Boolean

ShouldSerializeRotationTransition()

Declaration

public bool ShouldSerializeRotationTransition()

Returns

Type
System.Boolean

ShouldSerializeRotationTransitionSpeed()

Declaration

public bool ShouldSerializeRotationTransitionSpeed()

Returns

Type
System.Boolean

ShouldSerializeSelectionArrowColor()

Declaration

public bool ShouldSerializeSelectionArrowColor()

Returns

Type
System.Boolean

ShouldSerializeSelectionMarkerColor()

Declaration

public bool ShouldSerializeSelectionMarkerColor()

Returns

Type
System.Boolean

ShouldSerializeShowBanner()

Declaration

public bool ShouldSerializeShowBanner()

Returns

Type
System.Boolean

ShouldSerializeShowBannerIcon()

Declaration

public bool ShouldSerializeShowBannerIcon()

Returns

Type
System.Boolean

ShouldSerializeShowRotateTileBanner()

Declaration

public bool ShouldSerializeShowRotateTileBanner()

Returns

Type
System.Boolean

ShouldSerializeSlideTransition()

Declaration

public bool ShouldSerializeSlideTransition()

Returns

Type
System.Boolean

ShouldSerializeSwitchRotateTileBannerVisibility()

Declaration

public bool ShouldSerializeSwitchRotateTileBannerVisibility()

Returns

Type
System.Boolean

ShouldSerializeTileImage()

Declaration

public bool ShouldSerializeTileImage()

Returns

Type
System.Boolean

ShouldSerializeTitle()

Declaration

public bool ShouldSerializeTitle()

Returns

Type
System.Boolean

Events

BeforeTransition

This event will be triggered once HubTile transition is begins

Declaration

public event BeforeTransitionEventHandler BeforeTransition

Event Type

Type
BeforeTransitionEventHandler

SelectionMarked

This event will be triggered once HubTile Selection changed

Declaration

public event SelectionMarkedEventHandler SelectionMarked

Event Type

Type
SelectionMarkedEventHandler

TextChanged

This event will be triggered once HubTile Text contents changed

Declaration

public event EventHandler TextChanged

Event Type

Type
System.EventHandler

TransitionCompleted

This event will be triggered if after HubTile transition is completed

Declaration

public event TransitionCompletedEventHandler TransitionCompleted

Event Type

Type
TransitionCompletedEventHandler

ZoomCompleted

This event will be triggered once HubTile Zoom In and Zoom Out is done

Declaration

public event ZoomCompletedEventHandlerHandler ZoomCompleted

Event Type

Type
ZoomCompletedEventHandlerHandler