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

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.TextAttributeKit in_kit) |
Check if the source TextAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.TextAttributeKit in_kit) |
Copies all settings from the source TextAttributeKit into this object. More... | |
HPS.TextAttributeKit | SetAlignment (HPS.Text.Alignment in_align, HPS.Text.ReferenceFrame in_ref, HPS.Text.Justification in_justify) |
Sets the alignment for text. More... | |
HPS.TextAttributeKit | SetAlignment (HPS.Text.Alignment in_align, HPS.Text.ReferenceFrame in_ref) |
Sets the alignment for text. More... | |
HPS.TextAttributeKit | SetAlignment (HPS.Text.Alignment in_align) |
Sets the alignment for text. More... | |
HPS.TextAttributeKit | SetBackground (bool in_state, string in_name) |
Sets the background to be used with text. More... | |
HPS.TextAttributeKit | SetBackground (string in_name) |
Sets the background to be used with text. The state is implicitly on. More... | |
HPS.TextAttributeKit | SetBackground (bool in_state) |
Sets the background to be used with text. More... | |
HPS.TextAttributeKit | SetBackgroundMargins (float in_size, HPS.Text.MarginUnits in_units) |
Sets the amount of additional padding around text strings when backgrounds are used. More... | |
HPS.TextAttributeKit | SetBackgroundMargins (float in_size) |
Sets the amount of additional padding around text strings when backgrounds are used. More... | |
HPS.TextAttributeKit | SetBackgroundMargins (float[] in_sizes, HPS.Text.MarginUnits[] in_units) |
Sets the amount of additional padding around text strings when backgrounds are used. Additional margin values can also be referenced within definitions of background shapes and leader lines. More... | |
HPS.TextAttributeKit | SetBackgroundStyle (string in_name) |
Allows specifying a named style to be used in the drawing of text backgrounds. If no style is specified, backgrounds inherit the face and edge attributes from the containing segment. More... | |
HPS.TextAttributeKit | SetBold (bool in_state) |
Sets whether text should be bold. For fonts which do not have a bold variant, this setting will be ignored. More... | |
HPS.TextAttributeKit | SetExtraSpace (bool in_state, float in_size, HPS.Text.SizeUnits in_units) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextAttributeKit | SetExtraSpace (bool in_state, float in_size) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextAttributeKit | SetExtraSpace (bool in_state) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextAttributeKit | SetExtraSpace (float in_size, HPS.Text.SizeUnits in_units) |
Sets the amount of additional space to add between characters in a text string. This function implicitly enables the addition of extra space. More... | |
HPS.TextAttributeKit | SetFont (string in_name) |
Sets the font to use for text. This must either be a builtin font or a font Visualize can locate in the directories specified by World.SetFontDirectories. If the requested font cannot be found, the stroked font will be used. More... | |
HPS.TextAttributeKit | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeKit | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeKit | SetGreeking (bool in_state, float in_size) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeKit | SetGreeking (bool in_state) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeKit | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode) |
Sets the greeking settings to use for text. This function implicitly enables text greeking. More... | |
HPS.TextAttributeKit | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units) |
Sets the greeking settings to use for text. This function implicitly enables text greeking. More... | |
HPS.TextAttributeKit | SetGreeking (float in_size) |
Sets the greeking settings to use for text. This function implicitly enables text greeking. More... | |
HPS.TextAttributeKit | SetItalic (bool in_state) |
Sets whether text should be italic. For fonts which do not have an italic variant, this setting will be ignored. More... | |
HPS.TextAttributeKit | SetLineSpacing (float in_multiplier) |
Sets the line spacing multiplier for text. This is a multiple of the font size that will be used to determine spacing between lines in multi-line text string. More... | |
HPS.TextAttributeKit | SetOverline (bool in_state) |
Sets whether an overline should be drawn over text. More... | |
HPS.TextAttributeKit | SetPath (HPS.Vector in_path) |
Sets the path for text. This setting controls the vector along which text strings will be displayed. More... | |
HPS.TextAttributeKit | SetPreference (HPS.Text.Preference in_pref) |
Sets the font type preference for text. This function implicitly sets the same font type for all text sizes. More... | |
HPS.TextAttributeKit | SetPreference (float in_cutoff, HPS.Text.SizeUnits in_units, HPS.Text.Preference in_smaller, HPS.Text.Preference in_larger) |
Sets the preference for text. This setting controls which font type is used for text for "large" and "small" sizes and the cutoff at which this distinction is made. More... | |
HPS.TextAttributeKit | SetRenderer (HPS.Text.Renderer in_rend) |
Sets the renderer for text. More... | |
HPS.TextAttributeKit | SetRotation (HPS.Text.Rotation in_state, float in_angle) |
Sets the angle characters should be rotated within text strings. More... | |
HPS.TextAttributeKit | SetRotation (HPS.Text.Rotation in_state) |
Sets the angle characters should be rotated within text strings. More... | |
HPS.TextAttributeKit | SetRotation (float in_angle) |
Sets the angle characters should be rotated within text strings. This function implicitly sets a rotation state of Text.Rotation.Rotate. More... | |
HPS.TextAttributeKit | SetSize (float in_size, HPS.Text.SizeUnits in_units) |
Sets the font size to use for text. More... | |
HPS.TextAttributeKit | SetSizeTolerance (bool in_state, float in_size, HPS.Text.SizeToleranceUnits in_units) |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. More... | |
HPS.TextAttributeKit | SetSizeTolerance (bool in_state, float in_size) |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. More... | |
HPS.TextAttributeKit | SetSizeTolerance (bool in_state) |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. More... | |
HPS.TextAttributeKit | SetSizeTolerance (float in_size, HPS.Text.SizeToleranceUnits in_units) |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. This function implicitly enables a size tolerance. More... | |
HPS.TextAttributeKit | SetSlant (float in_angle) |
Sets the slant angle for text. This determines how far the characters in the string are sheared to the left (negative angle) or right (positive angle) relative to the perpendicular. More... | |
HPS.TextAttributeKit | SetSpacing (float in_multiplier) |
Sets the spacing multiplier for text. This setting controls the spacing between adjacent characters within a string. A value of 0.0f would result in all characters being drawn on top of each other, a value of 1.0f would be the standard spacing between characters, a value of 2.0f would insert twice as much space as would normally be between two characters, and so on. More... | |
HPS.TextAttributeKit | SetStrikethrough (bool in_state) |
Sets whether a strikethrough should be drawn through text. More... | |
HPS.TextAttributeKit | SetTransform (HPS.Text.Transform in_trans) |
Sets the transform behavior for text. More... | |
HPS.TextAttributeKit | SetUnderline (bool in_state) |
Sets whether an underline should be drawn under text. More... | |
void | Show (out HPS.TextAttributeKit out_kit) |
Copies all settings from this TextAttributeKit into the given TextAttributeKit. More... | |
bool | ShowAlignment (out HPS.Text.Alignment out_align, out HPS.Text.ReferenceFrame out_ref, out HPS.Text.Justification out_justify) |
Shows the alignment for text. More... | |
bool | ShowBackground (out bool out_state, out string out_name) |
Shows the background to be used with text. More... | |
bool | ShowBackgroundMargins (out float[] out_size, out HPS.Text.MarginUnits[] out_units) |
Shows the amount of additional padding around text strings when backgrounds are used. More... | |
bool | ShowBackgroundStyle (out string out_name) |
Shows the named style to be used in the drawing of text backgrounds. More... | |
bool | ShowBold (out bool out_state) |
Shows whether text should be bold. More... | |
bool | ShowExtraSpace (out bool out_state, out float out_size, out HPS.Text.SizeUnits out_units) |
Shows the amount of additional space to add between characters in a text string. More... | |
bool | ShowFont (out string out_name) |
Shows the font to use for text. More... | |
bool | ShowGreeking (out bool out_state, out float out_size, out HPS.Text.GreekingUnits out_units, out HPS.Text.GreekingMode out_mode) |
Shows the greeking settings to use for text. More... | |
bool | ShowItalic (out bool out_state) |
Shows whether text should be italic. More... | |
bool | ShowLineSpacing (out float out_multiplier) |
Shows the line spacing multiplier for text. More... | |
bool | ShowOverline (out bool out_state) |
Shows whether an overline should be drawn over text. More... | |
bool | ShowPath (out HPS.Vector out_path) |
Shows the path for text. More... | |
bool | ShowPreference (out float out_cutoff, out HPS.Text.SizeUnits out_units, out HPS.Text.Preference out_smaller, out HPS.Text.Preference out_larger) |
Shows the preference for text. More... | |
bool | ShowRenderer (out HPS.Text.Renderer out_rend) |
Shows the renderer for text. More... | |
bool | ShowRotation (out HPS.Text.Rotation out_rot, out float out_angle) |
Shows the angle characters should be rotated within text strings. More... | |
bool | ShowSize (out float out_size, out HPS.Text.SizeUnits out_units) |
Shows the font size to use for text. More... | |
bool | ShowSizeTolerance (out bool out_state, out float out_size, out HPS.Text.SizeToleranceUnits out_units) |
Shows the size tolerance settings to use for text. More... | |
bool | ShowSlant (out float out_angle) |
Shows the slant angle for text. More... | |
bool | ShowSpacing (out float out_multiplier) |
Shows the spacing multiplier for text. More... | |
bool | ShowStrikethrough (out bool out_state) |
Shows whether a strikethrough should be drawn through text. More... | |
bool | ShowTransform (out HPS.Text.Transform out_trans) |
Shows the transform state for text. More... | |
bool | ShowUnderline (out bool out_state) |
Shows whether an underline should be drawn under text. More... | |
TextAttributeKit () | |
Initializes an empty kit. More... | |
TextAttributeKit (HPS.TextAttributeKit in_kit) | |
The copy constructor creates a new TextAttributeKit object that contains the same settings as the source object. More... | |
HPS.TextAttributeKit | UnsetAlignment () |
Removes the alignment setting. More... | |
HPS.TextAttributeKit | UnsetBackground () |
Removes the background setting. More... | |
HPS.TextAttributeKit | UnsetBackgroundMargins () |
Removes the background margin setting. More... | |
HPS.TextAttributeKit | UnsetBackgroundStyle () |
Removes the background style setting. More... | |
HPS.TextAttributeKit | UnsetBold () |
Removes the bold setting. More... | |
HPS.TextAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.TextAttributeKit | UnsetExtraSpace () |
Removes the extra space setting. More... | |
HPS.TextAttributeKit | UnsetFont () |
Removes the font setting. More... | |
HPS.TextAttributeKit | UnsetGreeking () |
Removes the greeking setting. More... | |
HPS.TextAttributeKit | UnsetItalic () |
Removes the italic setting. More... | |
HPS.TextAttributeKit | UnsetLineSpacing () |
Removes the line spacing setting. More... | |
HPS.TextAttributeKit | UnsetOverline () |
Removes the overline setting. More... | |
HPS.TextAttributeKit | UnsetPath () |
Removes the path setting. More... | |
HPS.TextAttributeKit | UnsetPreference () |
Removes the preference setting. More... | |
HPS.TextAttributeKit | UnsetRenderer () |
Removes the renderer setting. More... | |
HPS.TextAttributeKit | UnsetRotation () |
Removes the rotation setting. More... | |
HPS.TextAttributeKit | UnsetSize () |
Removes the size setting. More... | |
HPS.TextAttributeKit | UnsetSizeTolerance () |
Removes the size tolerance setting. More... | |
HPS.TextAttributeKit | UnsetSlant () |
Removes the slant setting. More... | |
HPS.TextAttributeKit | UnsetSpacing () |
Removes the spacing setting. More... | |
HPS.TextAttributeKit | UnsetStrikethrough () |
Removes the strikethrough setting. More... | |
HPS.TextAttributeKit | UnsetTransform () |
Removes the transform setting. More... | |
HPS.TextAttributeKit | UnsetUnderline () |
Removes the underline setting. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.TextAttributeKit | GetDefault () |
Creates a TextAttributeKit 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. More... | |
static bool | operator!= (HPS.TextAttributeKit a, HPS.TextAttributeKit b) |
static bool | operator== (HPS.TextAttributeKit a, HPS.TextAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.TextAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.TextAttributeKit.GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new TextAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source TextAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source TextAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates a TextAttributeKit 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.
- Returns
- A TextAttributeKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Kit.
|
inline |
Copies all settings from the source TextAttributeKit into this object.
- Parameters
-
in_kit The source TextAttributeKit to copy.
|
inline |
Sets the alignment for text.
- Returns
- A reference to this object.
|
inline |
Sets the alignment for text.
- Returns
- A reference to this object.
|
inline |
Sets the alignment for text.
- Returns
- A reference to this object.
|
inline |
Sets the background to be used with text.
- Parameters
-
in_state Whether a background is drawn for text. in_name The name of a shape definition.
- Returns
- A reference to this object.
|
inline |
Sets the background to be used with text. The state is implicitly on.
- Parameters
-
in_name The name of a shape definition.
- Returns
- A reference to this object.
|
inline |
Sets the background to be used with text.
- Parameters
-
in_state Whether a background is drawn for text.
- Returns
- A reference to this object.
|
inline |
Sets the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
in_size The size of the margins. in_units The units of the size.
- Returns
- A reference to this object.
|
inline |
Sets the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
in_size The size of the margins.
- Returns
- A reference to this object.
|
inline |
Sets the amount of additional padding around text strings when backgrounds are used. Additional margin values can also be referenced within definitions of background shapes and leader lines.
- Parameters
-
in_sizes The size of the margins. in_units The units of the size.
- Returns
- A reference to this object.
|
inline |
Allows specifying a named style to be used in the drawing of text backgrounds. If no style is specified, backgrounds inherit the face and edge attributes from the containing segment.
- Parameters
-
in_name The name of a style, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Sets whether text should be bold. For fonts which do not have a bold variant, this setting will be ignored.
- Parameters
-
in_state Whether text should be bold.
- Returns
- A reference to this object.
|
inline |
Sets the amount of additional space to add between characters in a text string.
- Parameters
-
in_state Whether to add additional space between characters in a text string. in_size The size of the additional space to add between characters. in_units The units of the size of the additional space to add between characters.
- Returns
- A reference to this object.
|
inline |
Sets the amount of additional space to add between characters in a text string.
- Parameters
-
in_state Whether to add additional space between characters in a text string. in_size The size of the additional space to add between characters.
- Returns
- A reference to this object.
|
inline |
Sets the amount of additional space to add between characters in a text string.
- Parameters
-
in_state Whether to add additional space between characters in a text string.
- Returns
- A reference to this object.
|
inline |
Sets the amount of additional space to add between characters in a text string. This function implicitly enables the addition of extra space.
- Parameters
-
in_size The size of the additional space to add between characters. in_units The units of the size of the additional space to add between characters.
- Returns
- A reference to this object.
|
inline |
Sets the font to use for text. This must either be a builtin font or a font Visualize can locate in the directories specified by World.SetFontDirectories. If the requested font cannot be found, the stroked font will be used.
- Parameters
-
in_name UTF8-encoded font name to use for text.
- Returns
- A reference to this TextKey.
|
inline |
Sets the greeking settings to use for text.
- Parameters
-
in_state Whether greeking is enabled for text. in_size The size below which to draw a simple symbol in place of a character. in_units The units of the size below which to draw a simple glyph in place of a character. in_mode The type of symbol to draw for characters which are smaller than the greeking size.
- Returns
- A reference to this object.
|
inline |
Sets the greeking settings to use for text.
- Parameters
-
in_state Whether greeking is enabled for text. in_size The size below which to draw a simple symbol in place of a character. in_units The units of the size below which to draw a simple glyph in place of a character.
- Returns
- A reference to this object.
|
inline |
Sets the greeking settings to use for text.
- Parameters
-
in_state Whether greeking is enabled for text. in_size The size below which to draw a simple symbol in place of a character.
- Returns
- A reference to this object.
|
inline |
Sets the greeking settings to use for text.
- Parameters
-
in_state Whether greeking is enabled for text.
- Returns
- A reference to this object.
|
inline |
Sets the greeking settings to use for text. This function implicitly enables text greeking.
- Parameters
-
in_size The size below which to draw a simple symbol in place of a character. in_units The units of the size below which to draw a simple glyph in place of a character. in_mode The type of symbol to draw for characters which are smaller than the greeking size.
- Returns
- A reference to this object.
|
inline |
Sets the greeking settings to use for text. This function implicitly enables text greeking.
- Parameters
-
in_size The size below which to draw a simple symbol in place of a character. in_units The units of the size below which to draw a simple glyph in place of a character.
- Returns
- A reference to this object.
|
inline |
Sets the greeking settings to use for text. This function implicitly enables text greeking.
- Parameters
-
in_size The size below which to draw a simple symbol in place of a character.
- Returns
- A reference to this object.
|
inline |
Sets whether text should be italic. For fonts which do not have an italic variant, this setting will be ignored.
- Parameters
-
in_state Whether text should be italic.
- Returns
- A reference to this object.
|
inline |
Sets the line spacing multiplier for text. This is a multiple of the font size that will be used to determine spacing between lines in multi-line text string.
- Parameters
-
in_multiplier The line spacing multiplier for text.
- Returns
- A reference to this object.
|
inline |
Sets whether an overline should be drawn over text.
- Parameters
-
in_state Whether an overline should be drawn over text.
- Returns
- A reference to this object.
|
inline |
Sets the path for text. This setting controls the vector along which text strings will be displayed.
- Parameters
-
in_path The path for text.
- Returns
- A reference to this object.
|
inline |
Sets the font type preference for text. This function implicitly sets the same font type for all text sizes.
- Returns
- A reference to this object.
|
inline |
Sets the preference for text. This setting controls which font type is used for text for "large" and "small" sizes and the cutoff at which this distinction is made.
- Parameters
-
in_cutoff The font size below which the smaller preference is used and above which the larger preference is used. in_units The units for the font size below which the smaller preference is used and above which the larger preference is used. in_smaller The font type preference for strings below the cutoff size. in_larger The font type preference for strings above the cutoff size.
- Returns
- A reference to this object.
|
inline |
Sets the renderer for text.
- Returns
- A reference to this object.
|
inline |
Sets the angle characters should be rotated within text strings.
- Parameters
-
in_state Whether and how to rotate the characters within text string. in_angle The angle in degrees to rotate each character within text strings. This is only relevant if in_state is Text.Rotation.Rotate.
- Returns
- A reference to this object.
|
inline |
Sets the angle characters should be rotated within text strings.
- Parameters
-
in_state Whether and how to rotate the characters within text string.
- Returns
- A reference to this object.
|
inline |
Sets the angle characters should be rotated within text strings. This function implicitly sets a rotation state of Text.Rotation.Rotate.
- Parameters
-
in_angle The angle in degrees to rotate each character within text strings.
- Returns
- A reference to this object.
|
inline |
Sets the font size to use for text.
- Parameters
-
in_size The size for text. in_units The units of the size for text.
- Returns
- A reference to this object.
|
inline |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.
- Parameters
-
in_state Whether a size tolerance is enabled for text. in_size The size for the tolerance. in_units The units of the size for the tolerance.
- Returns
- A reference to this object.
|
inline |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.
- Parameters
-
in_state Whether a size tolerance is enabled for text. in_size The size for the tolerance.
- Returns
- A reference to this object.
|
inline |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts.
- Parameters
-
in_state Whether a size tolerance is enabled for text.
- Returns
- A reference to this object.
|
inline |
Sets the size tolerance settings to use for text. These settings control how to render text strings which request a size not available for a bitmap font. If a size tolerance is specified and enabled, Visualize will use the nearest smaller size for the bitmap font within the tolerance in place of the requested size. If a size tolerance is not enabled, Visualize will attempt to scale up the nearest bitmap font size to the requested size. This setting has no effect for True Type or Open Type fonts. This function implicitly enables a size tolerance.
- Parameters
-
in_size The size for the tolerance. in_units The units of the size for the tolerance.
- Returns
- A reference to this object.
|
inline |
Sets the slant angle for text. This determines how far the characters in the string are sheared to the left (negative angle) or right (positive angle) relative to the perpendicular.
- Parameters
-
in_angle The angle in degrees to slant text. This value must be in the range [-75.0f,+75.0f].
- Returns
- A reference to this object.
|
inline |
Sets the spacing multiplier for text. This setting controls the spacing between adjacent characters within a string. A value of 0.0f would result in all characters being drawn on top of each other, a value of 1.0f would be the standard spacing between characters, a value of 2.0f would insert twice as much space as would normally be between two characters, and so on.
- Parameters
-
in_multiplier The spacing multiplier for text.
- Returns
- A reference to this object.
|
inline |
Sets whether a strikethrough should be drawn through text.
- Parameters
-
in_state Whether a strikethrough should be drawn through text.
- Returns
- A reference to this object.
|
inline |
Sets the transform behavior for text.
- Returns
- A reference to this object.
|
inline |
Sets whether an underline should be drawn under text.
- Parameters
-
in_state Whether an underline should be drawn under text.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this TextAttributeKit into the given TextAttributeKit.
- Parameters
-
out_kit The TextAttributeKit to populate with the contents of this object.
|
inline |
Shows the alignment for text.
- Returns
- true if an alignment was set, false otherwise.
|
inline |
Shows the background to be used with text.
- Parameters
-
out_state Whether a background is drawn for text. out_name The name of a shape definition.
- Returns
- true if a spacing multiplier was set, false otherwise.
|
inline |
Shows the amount of additional padding around text strings when backgrounds are used.
- Parameters
-
out_size The size of the margins. out_units The units of the sizes.
- Returns
- true if a spacing multiplier was set, false otherwise.
|
inline |
Shows the named style to be used in the drawing of text backgrounds.
- Parameters
-
out_name The name of a style, defined in a portfolio that is accessible.
- Returns
- true if a spacing multiplier was set, false otherwise.
|
inline |
Shows whether text should be bold.
- Parameters
-
out_state Whether text should be bold.
- Returns
- true if a bold setting was set, false otherwise.
|
inline |
Shows the amount of additional space to add between characters in a text string.
- Parameters
-
out_state Whether to add additional space between characters in a text string. out_size The size of the additional space to add between characters. out_units The units of the size of the additional space to add between characters.
- Returns
- true if an extra space setting was set, false otherwise.
|
inline |
Shows the font to use for text.
- Parameters
-
out_name UTF8-encoded font name to use for text.
- Returns
- true if a font was set, false otherwise.
|
inline |
Shows the greeking settings to use for text.
- Parameters
-
out_state Whether greeking is enabled for text. out_size The size below which to draw a simple symbol in place of a character. out_units The units of the size below which to draw a simple glyph in place of a character. out_mode The type of symbol to draw for characters which are smaller than the greeking size.
- Returns
- true if greeking settings were set, false otherwise.
|
inline |
Shows whether text should be italic.
- Parameters
-
out_state Whether text should be italic.
- Returns
- true if an italic setting was set, false otherwise.
|
inline |
Shows the line spacing multiplier for text.
- Parameters
-
out_multiplier The line spacing multiplier for text.
- Returns
- true if a line space multiplier was set, false otherwise.
|
inline |
Shows whether an overline should be drawn over text.
- Parameters
-
out_state Whether an overline should be drawn over text.
- Returns
- true if an overline setting was set, false otherwise.
|
inline |
Shows the path for text.
- Parameters
-
out_path The path for text.
- Returns
- true if a path was set, false otherwise.
|
inline |
Shows the preference for text.
- Parameters
-
out_cutoff The font size below which the smaller preference is used and above which the larger preference is used. out_units The units for the font size below which the smaller preference is used and above which the larger preference is used. out_smaller The font type preference for strings below the cutoff size. out_larger The font type preference for strings above the cutoff size.
- Returns
- true if a preference was set, false otherwise.
|
inline |
Shows the renderer for text.
- Returns
- true if a renderer was set, false otherwise.
|
inline |
Shows the angle characters should be rotated within text strings.
- Parameters
-
out_rot Whether to rotate the characters within text strings, and if so, what the angle should be measured with repect to. out_angle The angle in degrees to rotate each character within text strings.
- Returns
- true if a rotation setting was set, false otherwise.
|
inline |
Shows the font size to use for text.
- Parameters
-
out_size The size for text. out_units The units of the size for text.
- Returns
- true if a size was set, false otherwise.
|
inline |
Shows the size tolerance settings to use for text.
- Parameters
-
out_state Whether a size tolerance is enabled for text. out_size The size for the tolerance. out_units The units of the size for the tolerance.
- Returns
- true if a size tolerance was set, false otherwise.
|
inline |
Shows the slant angle for text.
- Parameters
-
out_angle The angle in degrees to slant text.
- Returns
- true if a slang angle was set, false otherwise.
|
inline |
Shows the spacing multiplier for text.
- Parameters
-
out_multiplier The spacing multiplier for text.
- Returns
- true if a spacing multiplier was set, false otherwise.
|
inline |
Shows whether a strikethrough should be drawn through text.
- Parameters
-
out_state Whether a strikethrough should be drawn through text.
- Returns
- true if a strikethrough setting was set, false otherwise.
|
inline |
Shows the transform state for text.
- Returns
- true if a transform state was set, false otherwise.
|
inline |
Shows whether an underline should be drawn under text.
- Parameters
-
out_state Whether an underline should be drawn under text.
- Returns
- true if an underline setting was set, false otherwise.
|
inline |
Removes the alignment setting.
- Returns
- A reference to this object.
|
inline |
Removes the background setting.
- Returns
- A reference to this object.
|
inline |
Removes the background margin setting.
- Returns
- A reference to this object.
|
inline |
Removes the background style setting.
- Returns
- A reference to this object.
|
inline |
Removes the bold setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the extra space setting.
- Returns
- A reference to this object.
|
inline |
Removes the font setting.
- Returns
- A reference to this object.
|
inline |
Removes the greeking setting.
- Returns
- A reference to this object.
|
inline |
Removes the italic setting.
- Returns
- A reference to this object.
|
inline |
Removes the line spacing setting.
- Returns
- A reference to this object.
|
inline |
Removes the overline setting.
- Returns
- A reference to this object.
|
inline |
Removes the path setting.
- Returns
- A reference to this object.
|
inline |
Removes the preference setting.
- Returns
- A reference to this object.
|
inline |
Removes the renderer setting.
- Returns
- A reference to this object.
|
inline |
Removes the rotation setting.
- Returns
- A reference to this object.
|
inline |
Removes the size setting.
- Returns
- A reference to this object.
|
inline |
Removes the size tolerance setting.
- Returns
- A reference to this object.
|
inline |
Removes the slant setting.
- Returns
- A reference to this object.
|
inline |
Removes the spacing setting.
- Returns
- A reference to this object.
|
inline |
Removes the strikethrough setting.
- Returns
- A reference to this object.
|
inline |
Removes the transform setting.
- Returns
- A reference to this object.
|
inline |
Removes the underline setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TextAttributeKit.cs