Inheritance diagram for HPS.Publish.TextKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.TextKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.TextKit in_kit)
 
HPS.Publish.TextKit SetColor (HPS.RGBColor in_color)
 
HPS.Publish.TextKit SetFont (HPS.Publish.Text.Font.Name in_font)
 
HPS.Publish.TextKit SetFont (string in_font_name, HPS.Publish.Text.Language in_language, bool in_embed_font)
 
HPS.Publish.TextKit SetSize (int in_size)
 
HPS.Publish.TextKit SetText (string in_text)
 
void Show (out HPS.Publish.TextKit out_kit)
 
bool ShowColor (out HPS.RGBColor out_color)
 
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)
 
bool ShowSize (out int out_size)
 
bool ShowText (out string out_text)
 
 TextKit ()
 
 TextKit (HPS.Publish.TextKit in_kit)
 
HPS.Publish.TextKit UnsetColor ()
 
HPS.Publish.TextKit UnsetEverything ()
 
HPS.Publish.TextKit UnsetFont ()
 
HPS.Publish.TextKit UnsetSize ()
 
HPS.Publish.TextKit UnsetText ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Publish.TextKit GetDefault ()
 
static bool operator!= (HPS.Publish.TextKit a, HPS.Publish.TextKit b)
 
static bool operator== (HPS.Publish.TextKit a, HPS.Publish.TextKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ TextKit() [1/2]

HPS.Publish.TextKit.TextKit ( )
inline

The default constructor creates an empty TextKit object.

◆ TextKit() [2/2]

HPS.Publish.TextKit.TextKit ( HPS.Publish.TextKit  in_kit)
inline

The copy constructor creates a new TextKit object that contains the same settings as the source TextKit.

Parameters
in_kitThe source TextKit to copy.

Member Function Documentation

◆ 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()

bool HPS.Publish.TextKit.Equals ( HPS.Publish.TextKit  in_kit)
inline

Check if the source TextKit is equivalent to this TextKit.

Parameters
in_kitThe source TextKit to compare to this TextKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Publish.TextKit HPS.Publish.TextKit.GetDefault ( )
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.

◆ 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()

void HPS.Publish.TextKit.Set ( HPS.Publish.TextKit  in_kit)
inline

Copies the source TextKit into this TextKit.

Parameters
in_kitThe source TextKit to copy.

◆ SetColor()

HPS.Publish.TextKit HPS.Publish.TextKit.SetColor ( HPS.RGBColor  in_color)
inline

Sets the color for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_sColor or A3DPDFTextDataEx::m_sColor.

Parameters
in_colorColor for the text.
Returns
A reference to this TextKit.

◆ SetFont() [1/2]

HPS.Publish.TextKit HPS.Publish.TextKit.SetFont ( HPS.Publish.Text.Font.Name  in_font)
inline

Sets a built-in font for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_eFontName.

Parameters
in_fontThe built-in font for the text.
Returns
A reference to this TextKit.

◆ SetFont() [2/2]

HPS.Publish.TextKit HPS.Publish.TextKit.SetFont ( string  in_font_name,
HPS.Publish.Text.Language  in_language,
bool  in_embed_font 
)
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_nameUTF8-encoded font name for the text. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_pcFontName.
in_languageThe language for the font. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_eLanguage.
in_embed_fontWhether 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()

HPS.Publish.TextKit HPS.Publish.TextKit.SetSize ( int  in_size)
inline

Sets the size in points for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_iFontSize or A3DPDFTextDataEx::m_iFontSize.

Parameters
in_sizeThe size in points for the text.
Returns
A reference to this TextKit.

◆ SetText()

HPS.Publish.TextKit HPS.Publish.TextKit.SetText ( string  in_text)
inline

Sets the text string for the text. This corresponds to the value that will be passed to A3DPDFTextData::m_pcTextString or A3DPDFTextDataEx::m_pcTextString.

Parameters
in_textUTF8-encoded text string for the text.
Returns
A reference to this TextKit.

◆ Show()

void HPS.Publish.TextKit.Show ( out HPS.Publish.TextKit  out_kit)
inline

Copies this TextKit into the given TextKit.

Parameters
out_kitThe TextKit to populate with the contents of this TextKit.

◆ ShowColor()

bool HPS.Publish.TextKit.ShowColor ( out HPS.RGBColor  out_color)
inline

Shows the color setting

Parameters
out_colorThe color for the text.
Returns
true if a color was specified, false otherwise.

◆ ShowFont()

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 
)
inline

Shows the font setting.

Parameters
out_typeThe type of font for the text.
out_fontThe built-in font for the text. This is only valid if out_type is Text.Font.Type.BuiltIn.
out_font_nameThe explicit font name for the text. This is only valid if out_type is Text.Font.Type.Explicit.
out_languageThe language for the font. This is only valid if out_type is Text.Font.Type.Explicit.
out_embed_fontWhether 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.

◆ ShowSize()

bool HPS.Publish.TextKit.ShowSize ( out int  out_size)
inline

Shows the size setting.

Parameters
out_sizeThe 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_textThe text string for the text.
Returns
true if a text string was specified, false otherwise.

◆ UnsetColor()

HPS.Publish.TextKit HPS.Publish.TextKit.UnsetColor ( )
inline

Removes the color setting.

Returns
A reference to this TextKit.

◆ UnsetEverything()

HPS.Publish.TextKit HPS.Publish.TextKit.UnsetEverything ( )
inline

Removes all data from the text.

Returns
A reference to this TextKit.

◆ UnsetFont()

HPS.Publish.TextKit HPS.Publish.TextKit.UnsetFont ( )
inline

Removes the font setting.

Returns
A reference to this TextKit.

◆ UnsetSize()

HPS.Publish.TextKit HPS.Publish.TextKit.UnsetSize ( )
inline

Removes the size setting.

Returns
A reference to this TextKit.

◆ UnsetText()

HPS.Publish.TextKit HPS.Publish.TextKit.UnsetText ( )
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