REFERENCE MANUAL
The TextAttributeControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.TextAttributeControl | SetAlignment (HPS.Text.Alignment in_align, HPS.Text.ReferenceFrame in_ref, HPS.Text.Justification in_justify) |
Sets the alignment for text. More... | |
HPS.TextAttributeControl | SetAlignment (HPS.Text.Alignment in_align, HPS.Text.ReferenceFrame in_ref) |
Sets the alignment for text. More... | |
HPS.TextAttributeControl | SetAlignment (HPS.Text.Alignment in_align) |
Sets the alignment for text. More... | |
HPS.TextAttributeControl | SetBold (bool in_state) |
Sets whether text should be bold. More... | |
HPS.TextAttributeControl | 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.TextAttributeControl | SetExtraSpace (bool in_state, float in_size) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextAttributeControl | SetExtraSpace (bool in_state) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextAttributeControl | SetExtraSpace (float in_size, HPS.Text.SizeUnits in_units) |
Sets the amount of additional space to add between characters in a text string. More... | |
HPS.TextAttributeControl | SetFont (string in_name) |
Sets the font to use for text. More... | |
HPS.TextAttributeControl | 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.TextAttributeControl | SetGreeking (bool in_state, float in_size, HPS.Text.GreekingUnits in_units) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeControl | SetGreeking (bool in_state, float in_size) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeControl | SetGreeking (bool in_state) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeControl | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units, HPS.Text.GreekingMode in_mode) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeControl | SetGreeking (float in_size, HPS.Text.GreekingUnits in_units) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeControl | SetGreeking (float in_size) |
Sets the greeking settings to use for text. More... | |
HPS.TextAttributeControl | SetItalic (bool in_state) |
Sets whether text should be italic. More... | |
HPS.TextAttributeControl | SetLineSpacing (float in_multiplier) |
Sets the line spacing multiplier for text. More... | |
HPS.TextAttributeControl | SetOverline (bool in_state) |
Sets whether an overline should be drawn over text. More... | |
HPS.TextAttributeControl | SetPath (HPS.Vector in_path) |
Sets the path for text. More... | |
HPS.TextAttributeControl | SetPreference (HPS.Text.Preference in_pref) |
Sets the font type preference for text. More... | |
HPS.TextAttributeControl | SetPreference (float in_cutoff, HPS.Text.SizeUnits in_units, HPS.Text.Preference in_smaller, HPS.Text.Preference in_larger) |
Sets the preference for text. More... | |
HPS.TextAttributeControl | SetRenderer (HPS.Text.Renderer in_rend) |
Sets the renderer for text. More... | |
HPS.TextAttributeControl | SetRotation (HPS.Text.Rotation in_state, float in_angle) |
Sets the angle characters should be rotated within text strings. More... | |
HPS.TextAttributeControl | SetRotation (HPS.Text.Rotation in_state) |
Sets the angle characters should be rotated within text strings. More... | |
HPS.TextAttributeControl | SetRotation (float in_angle) |
Sets the angle characters should be rotated within text strings. More... | |
HPS.TextAttributeControl | SetSize (float in_size, HPS.Text.SizeUnits in_units) |
Sets the font size to use for text. More... | |
HPS.TextAttributeControl | SetSizeTolerance (bool in_state, float in_size, HPS.Text.SizeToleranceUnits in_units) |
Sets the size tolerance settings to use for text. More... | |
HPS.TextAttributeControl | SetSizeTolerance (bool in_state, float in_size) |
Sets the size tolerance settings to use for text. More... | |
HPS.TextAttributeControl | SetSizeTolerance (bool in_state) |
Sets the size tolerance settings to use for text. More... | |
HPS.TextAttributeControl | SetSizeTolerance (float in_size, HPS.Text.SizeToleranceUnits in_units) |
Sets the size tolerance settings to use for text. More... | |
HPS.TextAttributeControl | SetSlant (float in_angle) |
Sets the slant angle for text. More... | |
HPS.TextAttributeControl | SetSpacing (float in_multiplier) |
Sets the spacing multiplier for text. More... | |
HPS.TextAttributeControl | SetStrikethrough (bool in_state) |
Sets whether a strikethrough should be drawn through text. More... | |
HPS.TextAttributeControl | SetTransform (HPS.Text.Transform in_trans) |
Sets the transform behavior for text. More... | |
HPS.TextAttributeControl | SetUnderline (bool in_state) |
Sets whether an underline should be drawn under text. 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 | 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... | |
TextAttributeControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
TextAttributeControl (HPS.TextAttributeControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
HPS.TextAttributeControl | UnsetAlignment () |
Removes the alignment setting. More... | |
HPS.TextAttributeControl | UnsetBold () |
Removes the bold setting. More... | |
HPS.TextAttributeControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.TextAttributeControl | UnsetExtraSpace () |
Removes the extra space setting. More... | |
HPS.TextAttributeControl | UnsetFont () |
Removes the font setting. More... | |
HPS.TextAttributeControl | UnsetGreeking () |
Removes the greeking setting. More... | |
HPS.TextAttributeControl | UnsetItalic () |
Removes the italic setting. More... | |
HPS.TextAttributeControl | UnsetLineSpacing () |
Removes the line spacing setting. More... | |
HPS.TextAttributeControl | UnsetOverline () |
Removes the overline setting. More... | |
HPS.TextAttributeControl | UnsetPath () |
Removes the path setting. More... | |
HPS.TextAttributeControl | UnsetPreference () |
Removes the preference setting. More... | |
HPS.TextAttributeControl | UnsetRenderer () |
Removes the renderer setting. More... | |
HPS.TextAttributeControl | UnsetRotation () |
Removes the rotation setting. More... | |
HPS.TextAttributeControl | UnsetSize () |
Removes the size setting. More... | |
HPS.TextAttributeControl | UnsetSizeTolerance () |
Removes the size tolerance setting. More... | |
HPS.TextAttributeControl | UnsetSlant () |
Removes the slant setting. More... | |
HPS.TextAttributeControl | UnsetSpacing () |
Removes the spacing setting. More... | |
HPS.TextAttributeControl | UnsetStrikethrough () |
Removes the strikethrough setting. More... | |
HPS.TextAttributeControl | UnsetTransform () |
Removes the transform setting. More... | |
HPS.TextAttributeControl | UnsetUnderline () |
Removes the underline setting. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The TextAttributeControl class is a smart pointer that is tied to a database object.
This object gives you access to all the attributes associated with text, such as font, size, and rotation. Text characteristics such as bold, italic, and underline are also accessed through the TextAttributeControl. Default values for the various fields of TextAttributeControl can be found here.
HPS.TextAttributeControl.TextAttributeControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.TextAttributeControl.TextAttributeControl | ( | HPS.TextAttributeControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.TextAttributeControl HPS.TextAttributeControl.SetAlignment | ( | HPS.Text.Alignment | in_align, |
HPS.Text.ReferenceFrame | in_ref, | ||
HPS.Text.Justification | in_justify | ||
) |
Sets the alignment for text.
HPS.TextAttributeControl HPS.TextAttributeControl.SetAlignment | ( | HPS.Text.Alignment | in_align, |
HPS.Text.ReferenceFrame | in_ref | ||
) |
Sets the alignment for text.
HPS.TextAttributeControl HPS.TextAttributeControl.SetAlignment | ( | HPS.Text.Alignment | in_align | ) |
Sets the alignment for text.
HPS.TextAttributeControl HPS.TextAttributeControl.SetBold | ( | bool | in_state | ) |
Sets whether text should be bold.
For fonts which do not have a bold variant, this setting will be ignored.
in_state | Whether text should be bold. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetExtraSpace | ( | bool | in_state, |
float | in_size | ||
) |
Sets the amount of additional space to add between characters in a text string.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetExtraSpace | ( | bool | in_state | ) |
Sets the amount of additional space to add between characters in a text string.
in_state | Whether to add additional space between characters in a text string. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_name | UTF8-encoded font name to use for text. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetGreeking | ( | bool | in_state, |
float | in_size, | ||
HPS.Text.GreekingUnits | in_units | ||
) |
Sets the greeking settings to use for text.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetGreeking | ( | bool | in_state, |
float | in_size | ||
) |
Sets the greeking settings to use for text.
in_state | Whether greeking is enabled for text. |
in_size | The size below which to draw a simple symbol in place of a character. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetGreeking | ( | bool | in_state | ) |
Sets the greeking settings to use for text.
in_state | Whether greeking is enabled for text. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetGreeking | ( | float | in_size, |
HPS.Text.GreekingUnits | in_units | ||
) |
Sets the greeking settings to use for text.
This function implicitly enables text greeking.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetGreeking | ( | float | in_size | ) |
Sets the greeking settings to use for text.
This function implicitly enables text greeking.
in_size | The size below which to draw a simple symbol in place of a character. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetItalic | ( | bool | in_state | ) |
Sets whether text should be italic.
For fonts which do not have an italic variant, this setting will be ignored.
in_state | Whether text should be italic. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_multiplier | The line spacing multiplier for text. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetOverline | ( | bool | in_state | ) |
Sets whether an overline should be drawn over text.
in_state | Whether an overline should be drawn over text. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetPath | ( | HPS.Vector | in_path | ) |
Sets the path for text.
This setting controls the vector along which text strings will be displayed.
in_path | The path for text. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
HPS.TextAttributeControl HPS.TextAttributeControl.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.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetRenderer | ( | HPS.Text.Renderer | in_rend | ) |
Sets the renderer for text.
HPS.TextAttributeControl HPS.TextAttributeControl.SetRotation | ( | HPS.Text.Rotation | in_state, |
float | in_angle | ||
) |
Sets the angle characters should be rotated within text strings.
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 <ref refid="class_h_p_s_1_1_text_1af7d3ca00dd1173d8b8db7e1ba23dbda0a8d2de5368588552fbae54044ac5c7b3d" kindref="member">Text::Rotation::Rotate</ref>. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetRotation | ( | HPS.Text.Rotation | in_state | ) |
Sets the angle characters should be rotated within text strings.
in_state | Whether and how to rotate the characters within text string. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_angle | The angle in degrees to rotate each character within text strings. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetSize | ( | float | in_size, |
HPS.Text.SizeUnits | in_units | ||
) |
Sets the font size to use for text.
in_size | The size for text. |
in_units | The units of the size for text. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
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. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_state | Whether a size tolerance is enabled for text. |
in_size | The size for the tolerance. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_state | Whether a size tolerance is enabled for text. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_size | The size for the tolerance. |
in_units | The units of the size for the tolerance. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_angle | The angle in degrees to slant text. This value must be in the range [-75.0f,+75.0f]. |
HPS.TextAttributeControl HPS.TextAttributeControl.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.
in_multiplier | The spacing multiplier for text. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetStrikethrough | ( | bool | in_state | ) |
Sets whether a strikethrough should be drawn through text.
in_state | Whether a strikethrough should be drawn through text. |
HPS.TextAttributeControl HPS.TextAttributeControl.SetTransform | ( | HPS.Text.Transform | in_trans | ) |
Sets the transform behavior for text.
HPS.TextAttributeControl HPS.TextAttributeControl.SetUnderline | ( | bool | in_state | ) |
Sets whether an underline should be drawn under text.
in_state | Whether an underline should be drawn under text. |
bool HPS.TextAttributeControl.ShowAlignment | ( | out HPS.Text.Alignment | out_align, |
out HPS.Text.ReferenceFrame | out_ref, | ||
out HPS.Text.Justification | out_justify | ||
) |
Shows the alignment for text.
bool HPS.TextAttributeControl.ShowBold | ( | out bool | out_state | ) |
Shows whether text should be bold.
out_state | Whether text should be bold. |
bool HPS.TextAttributeControl.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.
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. |
bool HPS.TextAttributeControl.ShowFont | ( | out string | out_name | ) |
Shows the font to use for text.
out_name | UTF8-encoded font name to use for text. |
bool HPS.TextAttributeControl.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.
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. |
bool HPS.TextAttributeControl.ShowItalic | ( | out bool | out_state | ) |
Shows whether text should be italic.
out_state | Whether text should be italic. |
bool HPS.TextAttributeControl.ShowLineSpacing | ( | out float | out_multiplier | ) |
Shows the line spacing multiplier for text.
out_multiplier | The line spacing multiplier for text. |
bool HPS.TextAttributeControl.ShowOverline | ( | out bool | out_state | ) |
Shows whether an overline should be drawn over text.
out_state | Whether an overline should be drawn over text. |
bool HPS.TextAttributeControl.ShowPath | ( | out HPS.Vector | out_path | ) |
Shows the path for text.
out_path | The path for text. |
bool HPS.TextAttributeControl.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.
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. |
bool HPS.TextAttributeControl.ShowRenderer | ( | out HPS.Text.Renderer | out_rend | ) |
Shows the renderer for text.
bool HPS.TextAttributeControl.ShowRotation | ( | out HPS.Text.Rotation | out_rot, |
out float | out_angle | ||
) |
Shows the angle characters should be rotated within text strings.
out_angle | The angle in degrees to rotate each character within text strings. |
bool HPS.TextAttributeControl.ShowSize | ( | out float | out_size, |
out HPS.Text.SizeUnits | out_units | ||
) |
Shows the font size to use for text.
out_size | The size for text. |
out_units | The units of the size for text. |
bool HPS.TextAttributeControl.ShowSizeTolerance | ( | out bool | out_state, |
out float | out_size, | ||
out HPS.Text.SizeToleranceUnits | out_units | ||
) |
Shows the size tolerance settings to use for text.
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. |
bool HPS.TextAttributeControl.ShowSlant | ( | out float | out_angle | ) |
Shows the slant angle for text.
out_angle | The angle in degrees to slant text. |
bool HPS.TextAttributeControl.ShowSpacing | ( | out float | out_multiplier | ) |
Shows the spacing multiplier for text.
out_multiplier | The spacing multiplier for text. |
bool HPS.TextAttributeControl.ShowStrikethrough | ( | out bool | out_state | ) |
Shows whether a strikethrough should be drawn through text.
out_state | Whether a strikethrough should be drawn through text. |
bool HPS.TextAttributeControl.ShowTransform | ( | out HPS.Text.Transform | out_trans | ) |
Shows the transform state for text.
bool HPS.TextAttributeControl.ShowUnderline | ( | out bool | out_state | ) |
Shows whether an underline should be drawn under text.
out_state | Whether an underline should be drawn under text. |
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetAlignment | ( | ) |
Removes the alignment setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetBold | ( | ) |
Removes the bold setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetExtraSpace | ( | ) |
Removes the extra space setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetFont | ( | ) |
Removes the font setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetGreeking | ( | ) |
Removes the greeking setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetItalic | ( | ) |
Removes the italic setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetLineSpacing | ( | ) |
Removes the line spacing setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetOverline | ( | ) |
Removes the overline setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetPath | ( | ) |
Removes the path setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetPreference | ( | ) |
Removes the preference setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetRenderer | ( | ) |
Removes the renderer setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetRotation | ( | ) |
Removes the rotation setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetSize | ( | ) |
Removes the size setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetSizeTolerance | ( | ) |
Removes the size tolerance setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetSlant | ( | ) |
Removes the slant setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetSpacing | ( | ) |
Removes the spacing setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetStrikethrough | ( | ) |
Removes the strikethrough setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetTransform | ( | ) |
Removes the transform setting.
HPS.TextAttributeControl HPS.TextAttributeControl.UnsetUnderline | ( | ) |
Removes the underline setting.