The TextFieldKit class is a user space object. It acts as the container for all data that can be used to specify a text field for a Publish PDF. More...

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this TextFieldKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.TextFieldKit in_kit) |
Check if the source TextFieldKit is equivalent to this TextFieldKit. 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.TextFieldKit in_kit) |
Copies the source TextFieldKit into this TextFieldKit. More... | |
HPS.Publish.TextFieldKit | SetBorder (bool in_state) |
Sets whether the text field has a border. 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_field_data.html#a9b664261134e2f2843d16c47a759c805">A3DPDFTextFieldData::m_bHasBorder</ulink>. More... | |
HPS.Publish.TextFieldKit | SetBorderColor (HPS.RGBColor in_color) |
Sets the border color for the text field. 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_field_data.html#a45a6dc6ca0befa5c2fac4842d1dda5d0">A3DPDFTextFieldData::m_sBorderColor</ulink>. More... | |
HPS.Publish.TextFieldKit | SetBorderStyle (HPS.Publish.Border.Style in_style) |
Sets the border style for the text field. 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_field_data.html#ad192deaccbb00a0e91b127f7229d87aa">A3DPDFTextFieldData::m_eLineStyleBorder</ulink>. More... | |
HPS.Publish.TextFieldKit | SetBorderThickness (HPS.Publish.Border.Thickness in_thickness) |
Sets the border thickness for the text field. 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_field_data.html#ab039b181a012258aa4108f7f52b1acc9">A3DPDFTextFieldData::m_eThicknessBorder</ulink>. More... | |
HPS.Publish.TextFieldKit | SetDefaultValue (string in_value) |
Sets the default value for the text field. 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_field_data.html#a238cb8fc22eb59a5c5f3e62d21208644">A3DPDFTextFieldData::m_pcDefaultValue</ulink>. More... | |
HPS.Publish.TextFieldKit | SetFillColor (HPS.RGBColor in_color) |
Sets the fill color for the text field. 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_field_data.html#a1b7ed09daf0bbdc1300a5c6a6ac297c3">A3DPDFTextFieldData::m_sFillColor</ulink> and implicitly sets <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_field_data.html#a8f3b7f3f36404f295ecf62942cdaa680">A3DPDFTextFieldData::m_bHasFillColor</ulink> to true. More... | |
HPS.Publish.TextFieldKit | SetFont (HPS.Publish.Text.Font.Name in_name) |
Sets a builtin font for the text field. 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_field_data.html#a258a98b5920aba0002c65a9f4d33ce3f">A3DPDFTextFieldData::m_pcFontName</ulink>. More... | |
HPS.Publish.TextFieldKit | SetFont (string in_name, HPS.Publish.Text.Font.Style in_style) |
Sets a specific font for the text field. 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_field_data.html#a258a98b5920aba0002c65a9f4d33ce3f">A3DPDFTextFieldData::m_pcFontName</ulink>. More... | |
HPS.Publish.TextFieldKit | SetFont (string in_name) |
Sets a specific font for the text field. 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_field_data.html#a258a98b5920aba0002c65a9f4d33ce3f">A3DPDFTextFieldData::m_pcFontName</ulink>. More... | |
HPS.Publish.TextFieldKit | SetFontSize (int in_size) |
Sets the font size for the text field. 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_field_data.html#aa81644de695e055465ebf2bc290b3de7">A3DPDFTextFieldData::m_iFontSize</ulink>. More... | |
HPS.Publish.TextFieldKit | SetLock (bool in_state) |
Sets whether the text field is locked. 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_field_data.html#a7cddd56b6a26f4e605218c94e109dc38">A3DPDFTextFieldData::m_bIsLocked</ulink>. More... | |
HPS.Publish.TextFieldKit | SetMultiline (bool in_state) |
Sets whether the text field is multiline. 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_field_data.html#adc977b31dd4d224a62ad1e37107b266b">A3DPDFTextFieldData::m_bMultiline</ulink>. More... | |
HPS.Publish.TextFieldKit | SetName (string in_name) |
Sets the name of the text field. 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_field_data.html#aa80c111e6238b9a636b2484e59a8e72d">A3DPDFTextFieldData::m_pcName</ulink>. More... | |
HPS.Publish.TextFieldKit | SetPrintability (bool in_state) |
Sets the printability for the text field. 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_field_data.html#ab3a367c3b061889913e526183879d548">A3DPDFTextFieldData::m_eFormField</ulink>. More... | |
HPS.Publish.TextFieldKit | SetReadOnly (bool in_state) |
Sets whether the text field is read only. 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_field_data.html#a62c1657be16955023f55337ee47f6d5e">A3DPDFTextFieldData::m_bReadOnly</ulink>. More... | |
HPS.Publish.TextFieldKit | SetScrolling (bool in_state) |
Sets whether the text field can scroll. This corresponds to the (inverted) value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_field_data.html#abc187316edc79d3918f6c5d39c113815">A3DPDFTextFieldData::m_bDoNotScroll</ulink>. More... | |
HPS.Publish.TextFieldKit | SetTextColor (HPS.RGBColor in_color) |
Sets the text color for the text field. 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_field_data.html#a7bda027e619d995d9fb83482c2e31b1d">A3DPDFTextFieldData::m_sTextColor</ulink>. More... | |
HPS.Publish.TextFieldKit | SetTextJustification (HPS.Text.Justification in_justification) |
Sets the text justification for the text field. 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_field_data.html#ad528b189c2a0b627df1d72c773bbbde6">A3DPDFTextFieldData::m_eTextAlignment</ulink>. More... | |
HPS.Publish.TextFieldKit | SetTextRotation (HPS.Publish.Text.Rotation in_rotation) |
Sets the text rotation for the text field. 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_field_data.html#afd78252ea7eb673aa1b7e015dbdd3f1c">A3DPDFTextFieldData::m_eTextOrientation</ulink>. More... | |
HPS.Publish.TextFieldKit | SetTooltip (string in_tooltip) |
Sets the tooltip for the text field. 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_field_data.html#aa624cd8f6e77bd66550cca969401586f">A3DPDFTextFieldData::m_pcTooltip</ulink>. More... | |
HPS.Publish.TextFieldKit | SetVisibility (bool in_state) |
Sets the visibility for the text field. 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_field_data.html#ab3a367c3b061889913e526183879d548">A3DPDFTextFieldData::m_eFormField</ulink>. More... | |
void | Show (out HPS.Publish.TextFieldKit out_kit) |
Copies this TextFieldKit into the given TextFieldKit. More... | |
bool | ShowBorder (out bool out_state) |
Shows the border setting for the text field. More... | |
bool | ShowBorderColor (out HPS.RGBColor out_color) |
Shows the border color for the text field. More... | |
bool | ShowBorderStyle (out HPS.Publish.Border.Style out_style) |
Shows the border style for the text field. More... | |
bool | ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness) |
Shows the border thickness for the text field. More... | |
bool | ShowDefaultValue (out string out_value) |
Shows the default value for the text field. More... | |
bool | ShowFillColor (out HPS.RGBColor out_color) |
Shows the fill color for the text field. 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.Font.Style out_style) |
Shows the font for the text field. More... | |
bool | ShowFontSize (out int out_size) |
Shows the font size for the text field. More... | |
bool | ShowLock (out bool out_state) |
Shows the lock setting for the text field. More... | |
bool | ShowMultiline (out bool out_state) |
Shows the multiline setting for the text field. More... | |
bool | ShowName (out string out_name) |
Shows the name for the text field. More... | |
bool | ShowPrintability (out bool out_state) |
Shows the printability for the text field. More... | |
bool | ShowReadOnly (out bool out_state) |
Shows the read-only setting for the text field. More... | |
bool | ShowScrolling (out bool out_state) |
Shows the scrolling setting for the text field. More... | |
bool | ShowTextColor (out HPS.RGBColor out_color) |
Shows the text color for the text field. More... | |
bool | ShowTextJustification (out HPS.Text.Justification out_justification) |
Shows the text justification for the text field. More... | |
bool | ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation) |
Shows the text rotation for the text field. More... | |
bool | ShowTooltip (out string out_tooltip) |
Shows the tooltip for the text field. More... | |
bool | ShowVisibility (out bool out_state) |
Shows the visibility for the text field. More... | |
TextFieldKit () | |
The default constructor creates an empty TextFieldKit object. More... | |
TextFieldKit (HPS.Publish.TextFieldKit in_kit) | |
The copy constructor creates a new TextFieldKit object that contains the same settings as the source TextFieldKit. More... | |
HPS.Publish.TextFieldKit | UnsetBorder () |
Removes the border setting. More... | |
HPS.Publish.TextFieldKit | UnsetBorderColor () |
Removes the border color setting. More... | |
HPS.Publish.TextFieldKit | UnsetBorderStyle () |
Removes the border style setting. More... | |
HPS.Publish.TextFieldKit | UnsetBorderThickness () |
Removes the border thickness setting. More... | |
HPS.Publish.TextFieldKit | UnsetDefaultValue () |
Removes the default value setting. More... | |
HPS.Publish.TextFieldKit | UnsetEverything () |
Removes all data from the text field. More... | |
HPS.Publish.TextFieldKit | UnsetFillColor () |
Removes the fill color setting. More... | |
HPS.Publish.TextFieldKit | UnsetFont () |
Removes the font setting. More... | |
HPS.Publish.TextFieldKit | UnsetFontSize () |
Removes the font size setting. More... | |
HPS.Publish.TextFieldKit | UnsetLock () |
Removes the lock setting. More... | |
HPS.Publish.TextFieldKit | UnsetMultiline () |
Removes the multiline setting. More... | |
HPS.Publish.TextFieldKit | UnsetName () |
Removes the name setting. More... | |
HPS.Publish.TextFieldKit | UnsetPrintability () |
Removes the printability setting. More... | |
HPS.Publish.TextFieldKit | UnsetReadOnly () |
Removes the read-only setting. More... | |
HPS.Publish.TextFieldKit | UnsetScrolling () |
Removes the scrolling setting. More... | |
HPS.Publish.TextFieldKit | UnsetTextColor () |
Removes the text color setting. More... | |
HPS.Publish.TextFieldKit | UnsetTextJustification () |
Removes the text justification setting. More... | |
HPS.Publish.TextFieldKit | UnsetTextRotation () |
Removes the text rotation setting. More... | |
HPS.Publish.TextFieldKit | UnsetTooltip () |
Removes the tooltip setting. More... | |
HPS.Publish.TextFieldKit | UnsetVisibility () |
Removes the visibility 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.TextFieldKit | GetDefault () |
Creates a TextFieldKit 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 a text field unless a setting is overridden by the TextFieldKit passed to a function. More... | |
static bool | operator!= (HPS.Publish.TextFieldKit a, HPS.Publish.TextFieldKit b) |
static bool | operator== (HPS.Publish.TextFieldKit a, HPS.Publish.TextFieldKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The TextFieldKit class is a user space object. It acts as the container for all data that can be used to specify a text field for a Publish PDF.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty TextFieldKit object.
|
inline |
The copy constructor creates a new TextFieldKit object that contains the same settings as the source TextFieldKit.
- Parameters
-
in_kit The source TextFieldKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this TextFieldKit has any values set on it.
- Returns
- true if no values are set on this TextFieldKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source TextFieldKit is equivalent to this TextFieldKit.
- Parameters
-
in_kit The source TextFieldKit to compare to this TextFieldKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates a TextFieldKit 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 a text field unless a setting is overridden by the TextFieldKit passed to a function.
- Returns
- A TextFieldKit 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 |
Copies the source TextFieldKit into this TextFieldKit.
- Parameters
-
in_kit The source TextFieldKit to copy.
|
inline |
Sets whether the text field has a border. 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_field_data.html#a9b664261134e2f2843d16c47a759c805">A3DPDFTextFieldData::m_bHasBorder</ulink>.
- Parameters
-
in_state Whether the text field has a border.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the border color for the text field. 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_field_data.html#a45a6dc6ca0befa5c2fac4842d1dda5d0">A3DPDFTextFieldData::m_sBorderColor</ulink>.
- Parameters
-
in_color The border color of the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the border style for the text field. 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_field_data.html#ad192deaccbb00a0e91b127f7229d87aa">A3DPDFTextFieldData::m_eLineStyleBorder</ulink>.
- Parameters
-
in_style The border style for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the border thickness for the text field. 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_field_data.html#ab039b181a012258aa4108f7f52b1acc9">A3DPDFTextFieldData::m_eThicknessBorder</ulink>.
- Parameters
-
in_thickness The border thickness for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the default value for the text field. 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_field_data.html#a238cb8fc22eb59a5c5f3e62d21208644">A3DPDFTextFieldData::m_pcDefaultValue</ulink>.
- Parameters
-
in_value UT8-encoded default value for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the fill color for the text field. 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_field_data.html#a1b7ed09daf0bbdc1300a5c6a6ac297c3">A3DPDFTextFieldData::m_sFillColor</ulink> and implicitly sets <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_field_data.html#a8f3b7f3f36404f295ecf62942cdaa680">A3DPDFTextFieldData::m_bHasFillColor</ulink> to true.
- Parameters
-
in_color The fill color for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets a builtin font for the text field. 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_field_data.html#a258a98b5920aba0002c65a9f4d33ce3f">A3DPDFTextFieldData::m_pcFontName</ulink>.
- Parameters
-
in_name The builtin font for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets a specific font for the text field. 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_field_data.html#a258a98b5920aba0002c65a9f4d33ce3f">A3DPDFTextFieldData::m_pcFontName</ulink>.
- Parameters
-
in_name UTF8-encoded font name for the text field. in_style The style of font to use for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets a specific font for the text field. 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_field_data.html#a258a98b5920aba0002c65a9f4d33ce3f">A3DPDFTextFieldData::m_pcFontName</ulink>.
- Parameters
-
in_name UTF8-encoded font name for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the font size for the text field. 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_field_data.html#aa81644de695e055465ebf2bc290b3de7">A3DPDFTextFieldData::m_iFontSize</ulink>.
- Parameters
-
in_size The font size for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets whether the text field is locked. 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_field_data.html#a7cddd56b6a26f4e605218c94e109dc38">A3DPDFTextFieldData::m_bIsLocked</ulink>.
- Parameters
-
in_state Whether the text field is locked.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets whether the text field is multiline. 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_field_data.html#adc977b31dd4d224a62ad1e37107b266b">A3DPDFTextFieldData::m_bMultiline</ulink>.
- Parameters
-
in_state Whether the text field is multiline.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the name of the text field. 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_field_data.html#aa80c111e6238b9a636b2484e59a8e72d">A3DPDFTextFieldData::m_pcName</ulink>.
- Parameters
-
in_name UTF8-encoded name of the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the printability for the text field. 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_field_data.html#ab3a367c3b061889913e526183879d548">A3DPDFTextFieldData::m_eFormField</ulink>.
- Parameters
-
in_state The printability for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets whether the text field is read only. 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_field_data.html#a62c1657be16955023f55337ee47f6d5e">A3DPDFTextFieldData::m_bReadOnly</ulink>.
- Parameters
-
in_state Whether the text field can scroll.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets whether the text field can scroll. This corresponds to the (inverted) value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_text_field_data.html#abc187316edc79d3918f6c5d39c113815">A3DPDFTextFieldData::m_bDoNotScroll</ulink>.
- Parameters
-
in_state Whether the text field can scroll.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the text color for the text field. 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_field_data.html#a7bda027e619d995d9fb83482c2e31b1d">A3DPDFTextFieldData::m_sTextColor</ulink>.
- Parameters
-
in_color The text color for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the text justification for the text field. 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_field_data.html#ad528b189c2a0b627df1d72c773bbbde6">A3DPDFTextFieldData::m_eTextAlignment</ulink>.
- Parameters
-
in_justification The text justification for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the text rotation for the text field. 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_field_data.html#afd78252ea7eb673aa1b7e015dbdd3f1c">A3DPDFTextFieldData::m_eTextOrientation</ulink>.
- Parameters
-
in_rotation The text rotation for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the tooltip for the text field. 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_field_data.html#aa624cd8f6e77bd66550cca969401586f">A3DPDFTextFieldData::m_pcTooltip</ulink>.
- Parameters
-
in_tooltip UTF8-encoded tooltip text for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Sets the visibility for the text field. 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_field_data.html#ab3a367c3b061889913e526183879d548">A3DPDFTextFieldData::m_eFormField</ulink>.
- Parameters
-
in_state The visibility for the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Copies this TextFieldKit into the given TextFieldKit.
- Parameters
-
out_kit The TextFieldKit to populate with the contents of this TextFieldKit.
|
inline |
Shows the border setting for the text field.
- Parameters
-
out_state Whether the text field has a border.
- Returns
- true if a border setting was specified, false otherwise.
|
inline |
Shows the border color for the text field.
- Parameters
-
out_color The border color of the text field.
- Returns
- true if a border color was specified, false otherwise.
|
inline |
Shows the border style for the text field.
- Parameters
-
out_style The border style for the text field.
- Returns
- true if a border style was specified, false otherwise.
|
inline |
Shows the border thickness for the text field.
- Parameters
-
out_thickness The border thickness for the text field.
- Returns
- true if a border thickness was specified, false otherwise.
|
inline |
Shows the default value for the text field.
- Parameters
-
out_value The default value for the text field.
- Returns
- true if a default value was specified, false otherwise.
|
inline |
Shows the fill color for the text field.
- Parameters
-
out_color The fill color for the text field.
- Returns
- true if a fill color was specified, false otherwise.
|
inline |
Shows the font for the text field.
- Parameters
-
out_type The type of font for the text field. out_font The built-in font for the text field. This is only valid if out_type is Text::Font::Type::BuiltIn. out_font_name The explicit font name for the text field. This is only valid if out_type is Text::Font::Type::Explicit. out_style The font style for the text field. This is only valid if out_type is Text::Font::Type::Explicit.
- Returns
- true if a font was specified, false otherwise.
|
inline |
Shows the font size for the text field.
- Parameters
-
out_size The font size for the text field.
- Returns
- true if a font size was specified, false otherwise.
|
inline |
Shows the lock setting for the text field.
- Returns
- true if a lock setting was specified, false otherwise.
|
inline |
Shows the multiline setting for the text field.
- Parameters
-
out_state Whether the text field is multiline.
- Returns
- true if a multiline setting was specified, false otherwise.
|
inline |
Shows the name for the text field.
- Parameters
-
out_name The name of the text field.
- Returns
- true if a name was specified, false otherwise.
|
inline |
Shows the printability for the text field.
- Parameters
-
out_state The printability for the text field.
- Returns
- true if a printability was specified, false otherwise.
|
inline |
Shows the read-only setting for the text field.
- Parameters
-
out_state Whether the text field is read only.
- Returns
- true if a scrolling setting was specified, false otherwise.
|
inline |
Shows the scrolling setting for the text field.
- Parameters
-
out_state Whether the text field can scroll.
- Returns
- true if a scrolling setting was specified, false otherwise.
|
inline |
Shows the text color for the text field.
- Parameters
-
out_color The text color for the text field.
- Returns
- true if a text color was specified, false otherwise.
|
inline |
Shows the text justification for the text field.
- Parameters
-
out_justification The text justification for the text field.
- Returns
- true if a text justification was specified, false otherwise.
|
inline |
Shows the text rotation for the text field.
- Parameters
-
out_rotation The text rotation for the text field.
- Returns
- true if a rotation was specified, false otherwise.
|
inline |
Shows the tooltip for the text field.
- Parameters
-
out_tooltip The tooltip text for the text field.
- Returns
- true if a tooltip was specified, false otherwise.
|
inline |
Shows the visibility for the text field.
- Parameters
-
out_state The visibility for the text field.
- Returns
- true if a visibility was specified, false otherwise.
|
inline |
Removes the border setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the border color setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the border style setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the border thickness setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the default value setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes all data from the text field.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the fill color setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the font setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the font size setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the lock setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the multiline setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the name setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the printability setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the read-only setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the scrolling setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the text color setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the text justification setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the text rotation setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the tooltip setting.
- Returns
- A reference to this TextFieldKit.
|
inline |
Removes the visibility setting.
- Returns
- A reference to this TextFieldKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs