LineAttributeKit

class HPS.LineAttributeKit : HPS.Kit

The HPS.LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines. Calling HPS.LineAttributeKit.GetDefault() will return a kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return:true if no values are set on this object, false otherwise.

bool Equals (HPS.LineAttributeKit in_kit)

Check if the source LineAttributeKit is equivalent to this object.

Param in_kit:The source LineAttributeKit to compare to this object. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

LineAttributeKit ()

Initializes an empty kit.

LineAttributeKit (HPS.LineAttributeKit in_kit)

The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object.

Param in_kit:The source object to copy.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.LineAttributeKit in_kit)

Copies all settings from the source LineAttributeKit into this object.

Param in_kit:The source LineAttributeKit to copy.

HPS.LineAttributeKit SetPattern (string in_name)

Specifies the pattern of lines.

See also

Programming Guide: Line Patterns

Param in_name:The name of a line pattern, defined in a portfolio that is accessible. Return:A reference to this object.

HPS.LineAttributeKit SetPattern (string in_name, HPS.LinePatternOptionsKit in_options)

Specifies the pattern of lines.

See also

Programming Guide: Line Patterns

Param in_name:The name of a line pattern, defined in a portfolio that is accessible. Param in_options:  A set of options that modify how the named line pattern is applied. Return:A reference to this object.

HPS.LineAttributeKit SetWeight (float in_weight)

Sets the weight of lines.

Param in_weight:  The weight value for lines. Return:A reference to this object.

HPS.LineAttributeKit SetWeight (float in_weight, HPS.Line.SizeUnits in_units)

Sets the weight of lines.

Param in_weight:  The weight value for lines. Param in_units:The units applied to in_weight. Return:A reference to this object.

void Show (out HPS.LineAttributeKit out_kit)

Copies all settings from this LineAttributeKit into the given LineAttributeKit.

Param out_kit:The LineAttributeKit to populate with the contents of this object.

bool ShowPattern (out string out_pattern, out HPS.LinePatternOptionsKit out_options)

Shows the pattern used to draw lines.

Param out_pattern:  The name of a line pattern, defined in a portfolio that is accessible. Param out_options:  A set of options that modify how the named line pattern is applied. Return:true if the setting is valid, false otherwise.

bool ShowWeight (out float out_weight, out HPS.Line.SizeUnits out_units)

Shows the weight of lines.

Param out_weight:  The weight value for lines. Param out_units:  The units applied to in_weight. Return:true if the setting is valid, false otherwise.

HPS.LineAttributeKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.LineAttributeKit UnsetPattern ()

Removes the line pattern setting for lines.

Return:A reference to this object.

HPS.LineAttributeKit UnsetWeight ()

Removes the weight setting for lines.

Return:A reference to this object.

Public Static Functions

HPS.LineAttributeKit GetDefault ()

Creates a LineAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return:A LineAttributeKit with the default settings.

bool operator!= (HPS.LineAttributeKit a, HPS.LineAttributeKit b)

bool operator== (HPS.LineAttributeKit a, HPS.LineAttributeKit b)