Class TabPrimitive

The TabPrimitive class provides the required information.

Inheritance

System.Object

TabPrimitive

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class TabPrimitive

Constructors

TabPrimitive()

Declaration

public TabPrimitive()

TabPrimitive(TabPrimitiveType)

Declaration

public TabPrimitive(TabPrimitiveType type)

Parameters

Type	Name	Description
TabPrimitiveType	type

TabPrimitive(TabPrimitiveType, Image, Color, Boolean, Int32, String)

Declaration

public TabPrimitive(TabPrimitiveType type, Image image, Color transparentImageColor, bool visible, int indent, string name)

Parameters

Type	Name	Description
TabPrimitiveType	type
System.Drawing.Image	image
System.Drawing.Color	transparentImageColor
System.Boolean	visible
System.Int32	indent
System.String	name

TabPrimitive(TabPrimitiveType, Image, Color, Boolean, Int32, String, String)

Constructor of the TabPrimitive.

Declaration

public TabPrimitive(TabPrimitiveType type, Image image, Color transparentImageColor, bool visible, int indent, string name, string toolTipText)

Parameters

Type	Name	Description
TabPrimitiveType	type	The instance of the TabPrimitiveType.
System.Drawing.Image	image	The instance of the Image.
System.Drawing.Color	transparentImageColor	The transparent image color.
System.Boolean	visible	indicates whether the visible or not.
System.Int32	indent	The indent value.
System.String	name	The name if the TabPrimitive.
System.String	toolTipText	The ToolTip text.

Properties

Bounds

Gets primitive bounds.

Declaration

public Rectangle Bounds { get; }

Property Value

Type
System.Drawing.Rectangle

Enabled

Gets or sets a value indicating whether primitive enabled or not. If TabPrimitivType isn't Custom or DropDown then Enabled is sets automatically.

Declaration

public bool Enabled { get; set; }

Property Value

Type
System.Boolean

Image

Gets or sets image for draw foreground. If this value is null then draw default image.

Declaration

public Image Image { get; set; }

Property Value

Type
System.Drawing.Image

Indent

Gets or sets primitive indent.

Declaration

public int Indent { get; set; }

Property Value

Type
System.Int32

IsFullMode

Gets a value indicating whether fullmode or not. This property using only in DropDown primitive type.

Declaration

public bool IsFullMode { get; }

Property Value

Type
System.Boolean

Location

Gets this primitive location.

Declaration

public Point Location { get; }

Property Value

Type
System.Drawing.Point

Name

Gets or sets tab primitive name.

Declaration

public string Name { get; set; }

Property Value

Type
System.String

Size

Gets this primitive size.

Declaration

public Size Size { get; }

Property Value

Type
System.Drawing.Size

State

Gets primitive state. Flat == Hot.

Declaration

public ButtonState State { get; }

Property Value

Type
System.Windows.Forms.ButtonState

TabPrimitiveType

Gets or sets primitive type.

Declaration

public TabPrimitiveType TabPrimitiveType { get; set; }

Property Value

Type
TabPrimitiveType

ToolTip

Gets or sets the toolTip text for this tabPrimitive.

Declaration

public string ToolTip { get; set; }

Property Value

Type	Description
System.String	The toolTip text for this tabPrimitive.

TransparentImageColor

Gets or sets transparent image color.

Declaration

public Color TransparentImageColor { get; set; }

Property Value

Type
System.Drawing.Color

Visible

Gets or sets a value indicating whether primitive visible or not.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Methods

CalculateImageRect(Size)

Calculate image rectangle for paint.

Declaration

protected virtual Rectangle CalculateImageRect(Size bitmapSize)

Parameters

Type	Name	Description
System.Drawing.Size	bitmapSize	Image size.

Returns

Type	Description
System.Drawing.Rectangle	Returns Image Rectangle

Draw(Graphics)

Draw primitive.

Declaration

protected virtual void Draw(Graphics g)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object

DrawBackground(Graphics)

Draw primitive background.

Declaration

protected virtual void DrawBackground(Graphics g)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object

DrawBorder(Graphics)

Draw primitive border.

Declaration

protected virtual void DrawBorder(Graphics g)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object

DrawForeground(Graphics)

Draw primitive foreground.

Declaration

protected virtual void DrawForeground(Graphics g)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object

ResetTransparentImageColor()

Resets the TransparentImageColor property to its default value.

Declaration

public virtual void ResetTransparentImageColor()

ShouldSerialazeTransparentImageColor()

Indicates whether the current value of the TransparentImageColor property is to be serialized.

Declaration

protected virtual bool ShouldSerialazeTransparentImageColor()

Returns

Type	Description
System.Boolean	The color value.