Class PmpLabelDisplayingEventArgs

Namespace

Hymma.Solidworks.Addins

Assembly

Hymma.Solidworks.Addins.dll

event arguments for a PmpLabel

public class PmpLabelDisplayingEventArgs : PmpControlDisplayingEventArgs

Inheritance

object

EventArgs

PmpControlDisplayingEventArgs

PmpLabelDisplayingEventArgs

Inherited Members

PmpControlDisplayingEventArgs.OptionsForResize

PmpControlDisplayingEventArgs.Left

PmpControlDisplayingEventArgs.Width

EventArgs.Empty

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

PmpLabelDisplayingEventArgs(PmpLabel)

constructor

public PmpLabelDisplayingEventArgs(PmpLabel label)

Parameters

label PmpLabel

Properties

Height

Gets or sets the height of this label.

public short Height { get; set; }

Property Value

short

Remarks

Because SOLIDWORKS sizes the label appropriately based on the text it contains, you should not have to use this property. However, if the label does not contain text, then using this property might be useful.

Methods

GetBackgroundColor(short, short)

gets the background color for the specified range of characters in this PropertyManager label.

public Color GetBackgroundColor(short StartChar, short EndChar)

Parameters

StartChar short

0-based index value of start character

EndChar short

0-based index value of end character

Returns

Color

integer representation of the rgb color or -1 for error

GetBold(short, short)

get the bold status of specifid characteres

public bool GetBold(short start, short end)

Parameters

start short

0-based start index

end short

0-based end index

Returns

bool

GetCharacterColor(short, short)

gets the color of the specified characters in this PropertyManager label.

public Color GetCharacterColor(short StartChar, short EndChar)

Parameters

StartChar short

0-based index value of start character

EndChar short

0-based index value of end character

Returns

Color

RGB value for the text color for the specified characters or -1 for error

GetFont(short, short)

Gets the font for the specified characters in this PropertyManager label.

public string GetFont(short StartChar, short EndChar)

Parameters

StartChar short

0-based index value of start character

EndChar short

0-based index value of end character

Returns

string

Name of the font to use for the specified characters or empty string for error

GetLineOffset(short, short)

Gets whether to raise or lower the specified characters above or below their baselines, relative to their heights, in this PropertyManager label.

public double GetLineOffset(short StartChar, short EndChar)

Parameters

StartChar short

0-based index value of start character

EndChar short

0-based index value of end character

Returns

double

offset of this character

GetSizeRatio(short, short)

Gets the size of the specified characters in this PropertyManager label.

public double GetSizeRatio(short StartChar, short EndChar)

Parameters

StartChar short

0-based index value of start character

EndChar short

0-based index value of end character

Returns

double

Ratio for the height of the characters relative to their expected heights >0 increases their heights and <0 decreases their height

GetUnderLineStyle(short, short)

Gets underline style to the specified range of characters in this PropertyManager label.

public int GetUnderLineStyle(short StartChar, short EndChar)

Parameters

StartChar short

0-based index value of start character

EndChar short

0-based index value of end character

Returns

int

int value as defined by UnderLineStyles or -1 for errors