|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ TextKit() [1/2]
HPS.Publish.TextKit.TextKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty TextKit object.
◆ TextKit() [2/2]
The copy constructor creates a new TextKit object that contains the same settings as the source TextKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.TextKit.Empty |
( |
| ) |
|
|
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.
◆ Equals()
Check if the source TextKit is equivalent to this TextKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A TextKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.TextKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
◆ Set()
◆ SetColor()
◆ SetFont() [1/2]
Sets a built-in font for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_eFontName.
- Parameters
-
in_font | The built-in font for the text. |
- Returns
- A reference to this TextKit.
◆ SetFont() [2/2]
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.
◆ SetSize()
◆ SetText()
◆ Show()
◆ ShowColor()
bool HPS.Publish.TextKit.ShowColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the color setting
- Parameters
-
out_color | The color for the text. |
- Returns
- true if a color was specified, false otherwise.
◆ ShowFont()
Shows the font setting.
- Parameters
-
- Returns
- true if a font was specified, false otherwise.
◆ ShowSize()
bool HPS.Publish.TextKit.ShowSize |
( |
out int |
out_size | ) |
|
|
inline |
Shows the size setting.
- Parameters
-
out_size | The size for the text. |
- Returns
- true if a size was specified, false otherwise.
◆ ShowText()
bool HPS.Publish.TextKit.ShowText |
( |
out string |
out_text | ) |
|
|
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.
◆ UnsetColor()
Removes the color setting.
- Returns
- A reference to this TextKit.
◆ UnsetEverything()
Removes all data from the text.
- Returns
- A reference to this TextKit.
◆ UnsetFont()
Removes the font setting.
- Returns
- A reference to this TextKit.
◆ UnsetSize()
Removes the size setting.
- Returns
- A reference to this TextKit.
◆ UnsetText()
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