REFERENCE MANUAL
The TextKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this TextKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.TextKit in_kit) |
Check if the source TextKit is equivalent to this TextKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Publish.TextKit in_kit) |
Copies the source TextKit into this TextKit. More... | |
HPS.Publish.TextKit | SetColor (HPS.RGBColor in_color) |
Sets the color for the text. More... | |
HPS.Publish.TextKit | SetFont (HPS.Publish.Text.Font.Name in_font) |
Sets a built-in font for the text. More... | |
HPS.Publish.TextKit | SetFont (string in_font_name, HPS.Publish.Text.Language in_language, bool in_embed_font) |
Sets an explicit font for the text. More... | |
HPS.Publish.TextKit | SetSize (int in_size) |
Sets the size in points for the text. More... | |
HPS.Publish.TextKit | SetText (string in_text) |
Sets the text string for the text. More... | |
void | Show (out HPS.Publish.TextKit out_kit) |
Copies this TextKit into the given TextKit. More... | |
bool | ShowColor (out HPS.RGBColor out_color) |
Shows the color setting More... | |
bool | ShowFont (out HPS.Publish.Text.Font.Type out_type, out HPS.Publish.Text.Font.Name out_font, out string out_font_name, out HPS.Publish.Text.Language out_language, out bool out_embed_font) |
Shows the font setting. More... | |
bool | ShowSize (out int out_size) |
Shows the size setting. More... | |
bool | ShowText (out string out_text) |
Shows the text string setting. More... | |
TextKit () | |
The default constructor creates an empty TextKit object. More... | |
TextKit (HPS.Publish.TextKit in_kit) | |
The copy constructor creates a new TextKit object that contains the same settings as the source TextKit. More... | |
HPS.Publish.TextKit | UnsetColor () |
Removes the color setting. More... | |
HPS.Publish.TextKit | UnsetEverything () |
Removes all data from the text. More... | |
HPS.Publish.TextKit | UnsetFont () |
Removes the font setting. More... | |
HPS.Publish.TextKit | UnsetSize () |
Removes the size setting. More... | |
HPS.Publish.TextKit | UnsetText () |
Removes the text string setting. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.Publish.TextKit | GetDefault () |
Creates a TextKit which contains the default settings. More... | |
static bool | operator!= (HPS.Publish.TextKit a, HPS.Publish.TextKit b) |
static bool | operator== (HPS.Publish.TextKit a, HPS.Publish.TextKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The TextKit class is a user space object.
It acts as the container for all data that can be used to specify a text string for a Publish PDF.
HPS.Publish.TextKit.TextKit | ( | ) |
The default constructor creates an empty TextKit object.
HPS.Publish.TextKit.TextKit | ( | HPS.Publish.TextKit | in_kit | ) |
|
virtual |
Indicates whether this TextKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Publish.TextKit.Equals | ( | HPS.Publish.TextKit | in_kit | ) |
Check if the source TextKit is equivalent to this TextKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_text_kit" kindref="compound">TextKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_text_kit" kindref="compound">TextKit</ref>. |
|
static |
Creates a TextKit which contains the default settings.
The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the TextKit passed to File::Export.
|
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.
void HPS.Publish.TextKit.Set | ( | HPS.Publish.TextKit | in_kit | ) |
HPS.Publish.TextKit HPS.Publish.TextKit.SetColor | ( | HPS.RGBColor | in_color | ) |
Sets the color for the text.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data.html#af9b98ed87165494a3243d0d13513a596">A3DPDFTextData::m_sColor</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data_ex.html#aa780c227759b0c75d87db4fd186d0ddf">A3DPDFTextDataEx::m_sColor</ulink>.
in_color | Color for the text. |
HPS.Publish.TextKit HPS.Publish.TextKit.SetFont | ( | HPS.Publish.Text.Font.Name | in_font | ) |
Sets a built-in font for the text.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data.html#acd2684e945fd9ce23294af5f10d58365">A3DPDFTextData::m_eFontName</ulink>.
in_font | The built-in font for the text. |
HPS.Publish.TextKit HPS.Publish.TextKit.SetFont | ( | string | in_font_name, |
HPS.Publish.Text.Language | in_language, | ||
bool | in_embed_font | ||
) |
Sets an explicit font for the text.
As of Publish 5.11, this is only known to create a valid text string in the PDF if the font name is "MS Gothic" and the language is Japanese, otherwise the creation will fail.
in_font_name | UTF8-encoded font name for the text. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data_ex.html#a38dfb0879aafd915d6f1ea908f12749f">A3DPDFTextDataEx::m_pcFontName</ulink>. |
in_language | The language for the font. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data_ex.html#abe12b1fb142616bd9ce3da7f7f86cefb">A3DPDFTextDataEx::m_eLanguage</ulink>. |
in_embed_font | Whether to embed the font in the PDF. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data_ex.html#a0fa6e9cce5be920726da15963cc62539">A3DPDFTextDataEx::m_bEmbedFontInPDF</ulink>. |
HPS.Publish.TextKit HPS.Publish.TextKit.SetSize | ( | int | in_size | ) |
Sets the size in points for the text.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data.html#a0cf58cefed53657fb837e3441bfac53b">A3DPDFTextData::m_iFontSize</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data_ex.html#a94cb506c766286967e59c7d67929be7c">A3DPDFTextDataEx::m_iFontSize</ulink>.
in_size | The size in points for the text. |
HPS.Publish.TextKit HPS.Publish.TextKit.SetText | ( | string | in_text | ) |
Sets the text string for the text.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data.html#a46799fed1e4632775e5bd7a0821e821d">A3DPDFTextData::m_pcTextString</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_text_data_ex.html#ad1fea7e382e5d88734dbf69b04ff48c4">A3DPDFTextDataEx::m_pcTextString</ulink>.
in_text | UTF8-encoded text string for the text. |
void HPS.Publish.TextKit.Show | ( | out HPS.Publish.TextKit | out_kit | ) |
bool HPS.Publish.TextKit.ShowColor | ( | out HPS.RGBColor | out_color | ) |
Shows the color setting
out_color | The color for the text. |
bool HPS.Publish.TextKit.ShowFont | ( | out HPS.Publish.Text.Font.Type | out_type, |
out HPS.Publish.Text.Font.Name | out_font, | ||
out string | out_font_name, | ||
out HPS.Publish.Text.Language | out_language, | ||
out bool | out_embed_font | ||
) |
Shows the font setting.
out_type | The type of font for the text. |
out_font | The built-in font for the text. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01aca8f2e8d70641ce17b9b304086c19657" kindref="member">Text::Font::Type::BuiltIn</ref>. |
out_font_name | The explicit font name for the text. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>. |
out_language | The language for the font. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>. |
out_embed_font | Whether to embed the font in the PDF. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>. |
bool HPS.Publish.TextKit.ShowSize | ( | out int | out_size | ) |
Shows the size setting.
out_size | The size for the text. |
bool HPS.Publish.TextKit.ShowText | ( | out string | out_text | ) |
Shows the text string setting.
out_text | The text string for the text. |
HPS.Publish.TextKit HPS.Publish.TextKit.UnsetColor | ( | ) |
Removes the color setting.
HPS.Publish.TextKit HPS.Publish.TextKit.UnsetEverything | ( | ) |
Removes all data from the text.
HPS.Publish.TextKit HPS.Publish.TextKit.UnsetFont | ( | ) |
Removes the font setting.
HPS.Publish.TextKit HPS.Publish.TextKit.UnsetSize | ( | ) |
Removes the size setting.
HPS.Publish.TextKit HPS.Publish.TextKit.UnsetText | ( | ) |
Removes the text string setting.