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. 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. This does not necessarily give the true type of the underlying object. 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. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#af9b98ed87165494a3243d0d13513a596">A3DPDFTextData::m_sColor</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data_ex.html#aa780c227759b0c75d87db4fd186d0ddf">A3DPDFTextDataEx::m_sColor</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#acd2684e945fd9ce23294af5f10d58365">A3DPDFTextData::m_eFontName</ulink>. 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. 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. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#a0cf58cefed53657fb837e3441bfac53b">A3DPDFTextData::m_iFontSize</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data_ex.html#a94cb506c766286967e59c7d67929be7c">A3DPDFTextDataEx::m_iFontSize</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#a46799fed1e4632775e5bd7a0821e821d">A3DPDFTextData::m_pcTextString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data_ex.html#ad1fea7e382e5d88734dbf69b04ff48c4">A3DPDFTextDataEx::m_pcTextString</ulink>. 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. 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... | |
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... | |
Static Public Member Functions | |
static HPS.Publish.TextKit | GetDefault () |
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. 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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty TextKit object.
|
inline |
Member Function Documentation
|
inlinevirtual |
Indicates whether this TextKit has any values set on it.
- Returns
- true if no values are set on this TextKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
|
inlinestatic |
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.
- Returns
- A TextKit 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.Object.
|
inline |
|
inline |
Sets the color for the text. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#af9b98ed87165494a3243d0d13513a596">A3DPDFTextData::m_sColor</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data_ex.html#aa780c227759b0c75d87db4fd186d0ddf">A3DPDFTextDataEx::m_sColor</ulink>.
- Parameters
-
in_color Color for the text.
- Returns
- A reference to this TextKit.
|
inline |
Sets a built-in font for the text. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#acd2684e945fd9ce23294af5f10d58365">A3DPDFTextData::m_eFontName</ulink>.
- Parameters
-
in_font The built-in font for the text.
- Returns
- A reference to this TextKit.
|
inline |
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.
- Parameters
-
in_font_name UTF8-encoded font name for the text. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_pcFontName. in_language The language for the font. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_eLanguage. in_embed_font Whether to embed the font in the PDF. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_bEmbedFontInPDF.
- Returns
- A reference to this TextKit.
|
inline |
Sets the size in points for the text. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#a0cf58cefed53657fb837e3441bfac53b">A3DPDFTextData::m_iFontSize</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data_ex.html#a94cb506c766286967e59c7d67929be7c">A3DPDFTextDataEx::m_iFontSize</ulink>.
- Parameters
-
in_size The size in points for the text.
- Returns
- A reference to this TextKit.
|
inline |
Sets the text string for the text. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data.html#a46799fed1e4632775e5bd7a0821e821d">A3DPDFTextData::m_pcTextString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_data_ex.html#ad1fea7e382e5d88734dbf69b04ff48c4">A3DPDFTextDataEx::m_pcTextString</ulink>.
- Parameters
-
in_text UTF8-encoded text string for the text.
- Returns
- A reference to this TextKit.
|
inline |
|
inline |
Shows the color setting
- Parameters
-
out_color The color for the text.
- Returns
- true if a color was specified, false otherwise.
|
inline |
Shows the font setting.
- Parameters
-
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 Text::Font::Type::BuiltIn. out_font_name The explicit font name for the text. This is only valid if out_type is Text::Font::Type::Explicit. out_language The language for the font. This is only valid if out_type is Text::Font::Type::Explicit. out_embed_font Whether to embed the font in the PDF. This is only valid if out_type is Text::Font::Type::Explicit.
- Returns
- true if a font was specified, false otherwise.
|
inline |
Shows the size setting.
- Parameters
-
out_size The size for the text.
- Returns
- true if a size was specified, false otherwise.
|
inline |
Shows the text string setting.
- Parameters
-
out_text The text string for the text.
- Returns
- true if a text string was specified, false otherwise.
|
inline |
Removes the color setting.
- Returns
- A reference to this TextKit.
|
inline |
Removes all data from the text.
- Returns
- A reference to this TextKit.
|
inline |
Removes the font setting.
- Returns
- A reference to this TextKit.
|
inline |
Removes the size setting.
- Returns
- A reference to this TextKit.
|
inline |
Removes the text string setting.
- Returns
- A reference to this TextKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs