Inheritance diagram for HPS.Publish.ListBoxKit:
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.ListBoxKit in_kit)
 
override int GetHashCode ()
 
 ListBoxKit ()
 
 ListBoxKit (HPS.Publish.ListBoxKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.ListBoxKit in_kit)
 
HPS.Publish.ListBoxKit SetBorder (bool in_state)
 
HPS.Publish.ListBoxKit SetBorderColor (HPS.RGBColor in_color)
 
HPS.Publish.ListBoxKit SetBorderStyle (HPS.Publish.Border.Style in_style)
 
HPS.Publish.ListBoxKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)
 
HPS.Publish.ListBoxKit SetContents (string[] in_displayed_values, string[] in_export_values)
 
HPS.Publish.ListBoxKit SetFillColor (HPS.RGBColor in_color)
 
HPS.Publish.ListBoxKit SetFont (HPS.Publish.Text.Font.Name in_name)
 
HPS.Publish.ListBoxKit SetFont (string in_name, HPS.Publish.Text.Font.Style in_style)
 
HPS.Publish.ListBoxKit SetFont (string in_name)
 
HPS.Publish.ListBoxKit SetFontSize (int in_size)
 
HPS.Publish.ListBoxKit SetLock (bool in_state)
 
HPS.Publish.ListBoxKit SetMultipleSelection (bool in_state)
 
HPS.Publish.ListBoxKit SetName (string in_name)
 
HPS.Publish.ListBoxKit SetPrintability (bool in_state)
 
HPS.Publish.ListBoxKit SetTextColor (HPS.RGBColor in_color)
 
HPS.Publish.ListBoxKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)
 
HPS.Publish.ListBoxKit SetTooltip (string in_tooltip)
 
HPS.Publish.ListBoxKit SetVisibility (bool in_state)
 
void Show (out HPS.Publish.ListBoxKit out_kit)
 
bool ShowBorder (out bool out_state)
 
bool ShowBorderColor (out HPS.RGBColor out_color)
 
bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)
 
bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)
 
bool ShowContents (out string[] out_displayed_values, out string[] out_export_values)
 
bool ShowFillColor (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.Font.Style out_style)
 
bool ShowFontSize (out int out_size)
 
bool ShowLock (out bool out_state)
 
bool ShowMultipleSelection (out bool out_state)
 
bool ShowName (out string out_name)
 
bool ShowPrintability (out bool out_state)
 
bool ShowTextColor (out HPS.RGBColor out_color)
 
bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)
 
bool ShowTooltip (out string out_tooltip)
 
bool ShowVisibility (out bool out_state)
 
HPS.Publish.ListBoxKit UnsetBorder ()
 
HPS.Publish.ListBoxKit UnsetBorderColor ()
 
HPS.Publish.ListBoxKit UnsetBorderStyle ()
 
HPS.Publish.ListBoxKit UnsetBorderThickness ()
 
HPS.Publish.ListBoxKit UnsetContents ()
 
HPS.Publish.ListBoxKit UnsetEverything ()
 
HPS.Publish.ListBoxKit UnsetFillColor ()
 
HPS.Publish.ListBoxKit UnsetFont ()
 
HPS.Publish.ListBoxKit UnsetFontSize ()
 
HPS.Publish.ListBoxKit UnsetLock ()
 
HPS.Publish.ListBoxKit UnsetMultipleSelection ()
 
HPS.Publish.ListBoxKit UnsetName ()
 
HPS.Publish.ListBoxKit UnsetPrintability ()
 
HPS.Publish.ListBoxKit UnsetTextColor ()
 
HPS.Publish.ListBoxKit UnsetTextRotation ()
 
HPS.Publish.ListBoxKit UnsetTooltip ()
 
HPS.Publish.ListBoxKit UnsetVisibility ()
 
- 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.ListBoxKit GetDefault ()
 
static bool operator!= (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit b)
 
static bool operator== (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit 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 ListBoxKit class is a user space object. It acts as the container for all data that can be used to specify a list box for a Publish PDF.

Constructor & Destructor Documentation

◆ ListBoxKit() [1/2]

HPS.Publish.ListBoxKit.ListBoxKit ( )
inline

The default constructor creates an empty ListBoxKit object.

◆ ListBoxKit() [2/2]

HPS.Publish.ListBoxKit.ListBoxKit ( HPS.Publish.ListBoxKit  in_kit)
inline

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

Parameters
in_kitThe source ListBoxKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Publish.ListBoxKit.Empty ( )
inlinevirtual

Indicates whether this ListBoxKit has any values set on it.

Returns
true if no values are set on this ListBoxKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source ListBoxKit is equivalent to this ListBoxKit.

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

◆ GetDefault()

static HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.GetDefault ( )
inlinestatic

Creates a ListBoxKit 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 button unless a setting is overridden by the ListBoxKit passed to a function.

Returns
A ListBoxKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.Publish.ListBoxKit.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.ListBoxKit.Set ( HPS.Publish.ListBoxKit  in_kit)
inline

Copies the source ListBoxKit into this ListBoxKit.

Parameters
in_kitThe source ListBoxKit to copy.

◆ SetBorder()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorder ( bool  in_state)
inline

Sets whether the list box has a border. This corresponds to the value that will be passed to A3DPDFListBoxData::m_bHasBorder.

Parameters
in_stateWhether the list box has a border.
Returns
A reference to this ListBoxKit.

◆ SetBorderColor()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorderColor ( HPS.RGBColor  in_color)
inline

Sets the border color for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_sBorderColor.

Parameters
in_colorThe border color of the list box.
Returns
A reference to this ListBoxKit.

◆ SetBorderStyle()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorderStyle ( HPS.Publish.Border.Style  in_style)
inline

Sets the border style for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eLineStyleBorder.

Parameters
in_styleThe border style for the list box.
Returns
A reference to this ListBoxKit.

◆ SetBorderThickness()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorderThickness ( HPS.Publish.Border.Thickness  in_thickness)
inline

Sets the border thickness for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eThicknessBorder.

Parameters
in_thicknessThe border thickness for the list box.
Returns
A reference to this ListBoxKit.

◆ SetContents()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetContents ( string []  in_displayed_values,
string []  in_export_values 
)
inline

Sets the contents of the list box. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. The two arrays need to have the same size.

Parameters
in_displayed_valuesThe values displayed in the list box
in_export_valuesThe export values associated with the values displayed
Returns
A reference to this ListBoxKit.

◆ SetFillColor()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFillColor ( HPS.RGBColor  in_color)
inline

Sets the fill color for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_sFillColor and implicitly sets A3DPDFListBoxData::m_bHasFillColor to true.

Parameters
in_colorThe fill color for the list box.
Returns
A reference to this ListBoxKit.

◆ SetFont() [1/3]

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFont ( HPS.Publish.Text.Font.Name  in_name)
inline

Sets a builtin font for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcFontName.

Parameters
in_nameThe builtin font for the list box.
Returns
A reference to this ListBoxKit.

◆ SetFont() [2/3]

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFont ( string  in_name,
HPS.Publish.Text.Font.Style  in_style 
)
inline

Sets a specific font for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcFontName.

Parameters
in_nameUTF8-encoded font name for the list box.
in_styleThe style of font to use for the list box.
Returns
A reference to this ListBoxKit.

◆ SetFont() [3/3]

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFont ( string  in_name)
inline

Sets a specific font for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcFontName.

Parameters
in_nameUTF8-encoded font name for the list box.
Returns
A reference to this ListBoxKit.

◆ SetFontSize()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFontSize ( int  in_size)
inline

Sets the font size for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_iFontSize.

Parameters
in_sizeThe font size for the list box.
Returns
A reference to this ListBoxKit.

◆ SetLock()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetLock ( bool  in_state)
inline

Sets whether the list box is locked. This corresponds to the value that will be passed to A3DPDFListBoxData::m_bIsLocked.

Parameters
in_stateWhether the list box is locked.
Returns
A reference to this ListBoxKit.

◆ SetMultipleSelection()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetMultipleSelection ( bool  in_state)
inline

Sets whether multiple selection is allowed. This corresponds to the value that will be passed to A3DPDFListBoxData::m_bMultipleSelection.

Parameters
in_stateWhether multiple selection is allowed
Returns
A reference to this ListBoxKit.

◆ SetName()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetName ( string  in_name)
inline

Sets the name of the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcName.

Parameters
in_nameUTF8-encoded name of the list box.
Returns
A reference to this ListBoxKit.

◆ SetPrintability()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetPrintability ( bool  in_state)
inline

Sets the printability for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eFormField.

Parameters
in_stateThe printability for the list box.
Returns
A reference to this ListBoxKit.

◆ SetTextColor()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetTextColor ( HPS.RGBColor  in_color)
inline

Sets the text color for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_sTextColor.

Parameters
in_colorThe text color for the list box.
Returns
A reference to this ListBoxKit.

◆ SetTextRotation()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetTextRotation ( HPS.Publish.Text.Rotation  in_rotation)
inline

Sets the text rotation for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eTextOrientation.

Parameters
in_rotationThe text rotation for the list box.
Returns
A reference to this ListBoxKit.

◆ SetTooltip()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetTooltip ( string  in_tooltip)
inline

Sets the tooltip for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcTooltip.

Parameters
in_tooltipUTF8-encoded tooltip text for the list box.
Returns
A reference to this ListBoxKit.

◆ SetVisibility()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetVisibility ( bool  in_state)
inline

Sets the visibility for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eFormField.

Parameters
in_stateThe visibility for the list box.
Returns
A reference to this ListBoxKit.

◆ Show()

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

Copies this ListBoxKit into the given ListBoxKit.

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

◆ ShowBorder()

bool HPS.Publish.ListBoxKit.ShowBorder ( out bool  out_state)
inline

Shows the border setting for the list box.

Parameters
out_stateWhether the list box has a border.
Returns
true if a border setting was specified, false otherwise.

◆ ShowBorderColor()

bool HPS.Publish.ListBoxKit.ShowBorderColor ( out HPS.RGBColor  out_color)
inline

Shows the border color for the list box.

Parameters
out_colorThe border color of the list box.
Returns
true if a border color was specified, false otherwise.

◆ ShowBorderStyle()

bool HPS.Publish.ListBoxKit.ShowBorderStyle ( out HPS.Publish.Border.Style  out_style)
inline

Shows the border style for the list box.

Parameters
out_styleThe border style for the list box.
Returns
true if a border style was specified, false otherwise.

◆ ShowBorderThickness()

bool HPS.Publish.ListBoxKit.ShowBorderThickness ( out HPS.Publish.Border.Thickness  out_thickness)
inline

Shows the border thickness for the list box.

Parameters
out_thicknessThe border thickness for the list box.
Returns
true if a border thickness was specified, false otherwise.

◆ ShowFillColor()

bool HPS.Publish.ListBoxKit.ShowFillColor ( out HPS.RGBColor  out_color)
inline

Shows the fill color for the list box.

Parameters
out_colorThe fill color for the list box.
Returns
true if a fill color was specified, false otherwise.

◆ ShowFont()

bool HPS.Publish.ListBoxKit.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 
)
inline

Shows the font for the list box.

Parameters
out_typeThe type of font for the list box.
out_fontThe built-in font for the list box. This is only valid if out_type is Text.Font.Type.BuiltIn.
out_font_nameThe explicit font name for the list box. This is only valid if out_type is Text.Font.Type.Explicit.
out_styleThe font style for the list box. This is only valid if out_type is Text.Font.Type.Explicit.
Returns
true if a font was specified, false otherwise.

◆ ShowFontSize()

bool HPS.Publish.ListBoxKit.ShowFontSize ( out int  out_size)
inline

Shows the font size for the list box.

Parameters
out_sizeThe font size for the list box.
Returns
true if a font size was specified, false otherwise.

◆ ShowLock()

bool HPS.Publish.ListBoxKit.ShowLock ( out bool  out_state)
inline

Shows the lock setting for the list box.

Returns
true if a lock setting was specified, false otherwise.

◆ ShowMultipleSelection()

bool HPS.Publish.ListBoxKit.ShowMultipleSelection ( out bool  out_state)
inline

Shows the multiple selection setting for the list box.

Parameters
out_stateWhether multiple selection is enabled.
Returns
true if a multiple selection setting was specified, false otherwise.

◆ ShowName()

bool HPS.Publish.ListBoxKit.ShowName ( out string  out_name)
inline

Shows the name for the list box.

Parameters
out_nameThe name of the list box.
Returns
true if a name was specified, false otherwise.

◆ ShowPrintability()

bool HPS.Publish.ListBoxKit.ShowPrintability ( out bool  out_state)
inline

Shows the printability for the list box.

Parameters
out_stateThe printability for the list box.
Returns
true if a printability was specified, false otherwise.

◆ ShowTextColor()

bool HPS.Publish.ListBoxKit.ShowTextColor ( out HPS.RGBColor  out_color)
inline

Shows the text color for the list box.

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

◆ ShowTextRotation()

bool HPS.Publish.ListBoxKit.ShowTextRotation ( out HPS.Publish.Text.Rotation  out_rotation)
inline

Shows the text rotation for the list box.

Parameters
out_rotationThe text rotation for the list box.
Returns
true if a rotation was specified, false otherwise.

◆ ShowTooltip()

bool HPS.Publish.ListBoxKit.ShowTooltip ( out string  out_tooltip)
inline

Shows the tooltip for the list box.

Parameters
out_tooltipThe tooltip text for the list box.
Returns
true if a tooltip was specified, false otherwise.

◆ ShowVisibility()

bool HPS.Publish.ListBoxKit.ShowVisibility ( out bool  out_state)
inline

Shows the visibility for the list box.

Parameters
out_stateThe visibility for the list box.
Returns
true if a visibility was specified, false otherwise.

◆ UnsetBorder()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorder ( )
inline

Removes the border setting.

Returns
A reference to this ListBoxKit.

◆ UnsetBorderColor()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorderColor ( )
inline

Removes the border color setting.

Returns
A reference to this ListBoxKit.

◆ UnsetBorderStyle()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorderStyle ( )
inline

Removes the border style setting.

Returns
A reference to this ListBoxKit.

◆ UnsetBorderThickness()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorderThickness ( )
inline

Removes the border thickness setting.

Returns
A reference to this ListBoxKit.

◆ UnsetContents()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetContents ( )
inline

Removes the content setting.

Returns
A reference to this ListBoxKit.

◆ UnsetEverything()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetEverything ( )
inline

Removes all data from the list box.

Returns
A reference to this ListBoxKit.

◆ UnsetFillColor()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetFillColor ( )
inline

Removes the fill color setting.

Returns
A reference to this ListBoxKit.

◆ UnsetFont()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetFont ( )
inline

Removes the font setting.

Returns
A reference to this ListBoxKit.

◆ UnsetFontSize()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetFontSize ( )
inline

Removes the font size setting.

Returns
A reference to this ListBoxKit.

◆ UnsetLock()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetLock ( )
inline

Removes the lock setting.

Returns
A reference to this ListBoxKit.

◆ UnsetMultipleSelection()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetMultipleSelection ( )
inline

Removes the multiple selection setting.

Returns
A reference to this ListBoxKit.

◆ UnsetName()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetName ( )
inline

Removes the name setting.

Returns
A reference to this ListBoxKit.

◆ UnsetPrintability()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetPrintability ( )
inline

Removes the printability setting.

Returns
A reference to this ListBoxKit.

◆ UnsetTextColor()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetTextColor ( )
inline

Removes the text color setting.

Returns
A reference to this ListBoxKit.

◆ UnsetTextRotation()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetTextRotation ( )
inline

Removes the text rotation setting.

Returns
A reference to this ListBoxKit.

◆ UnsetTooltip()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetTooltip ( )
inline

Removes the tooltip setting.

Returns
A reference to this ListBoxKit.

◆ UnsetVisibility()

HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetVisibility ( )
inline

Removes the visibility setting.

Returns
A reference to this ListBoxKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_publish/source/cs/HPS.Publish.cs