Publish

class HPS.Publish : public IDisposable

The Publish class contains objects and enumerations used for exporting 3D PDF files via Publish.

Public Functions

void Dispose ()
Publish (HPS.Publish in_that)
class Activation : public IDisposable

The Publish.Activation class is a concept class for activation-related enumerations.

Public Types

enum When

Enumerates when an annotation is activated.

Values:

Explicit

Annotation is not activated until a script or the user explicitly activates it, e.g., by clicking on a poster image (kA3DPDFActivExplicitActivation).

Opened

Annotation is activated when the page containing it is opened (<a target=”_blank”.

Visible

Annotation is activated when the page containing it is visible (kA3DPDFActivPageVisible).

Public Functions

Activation (HPS.Publish.Activation in_that)
void Dispose ()
class Animation : public IDisposable

The Publish.Animation class is a concept class for animation-related enumerations.

Public Types

enum Style

Enumerates the animation styles for an ArtworkKit.

Values:

None

Reader does not control the animation allowing it to be driven through other means, e.g., JavaScript (kA3DPDFAnimStyleNoAnimation).

Loop

Reader loops through the animation continuously (kA3DPDFAnimStyleLoop).

Bounce

Reader plays the animation forwards and backward continuously (kA3DPDFAnimStyleBounce).

Public Functions

Animation (HPS.Publish.Animation in_that)
void Dispose ()
class Annotation : public IDisposable

The Publish.Annotation class is a concept class for annotation-related enums.

Public Types

enum Format

Enumerates the format of the data to put in an annotation.

Values:

PRC

PRC data will be generated for the annotation.

U3D

U3D data will be generated for the annotation.

enum SourceType

Values:

CADModel

The source was set using a CADModel object.

KeyPath

The source was set using a KeyPath array.

CADModelAndKeyPath

The source was set using both a CADModel and a KeyPath array.

Public Functions

Annotation (HPS.Publish.Annotation in_that)
void Dispose ()
class AnnotationKit : public HPS.SprocketKit

The AnnotationKit class is a user space object. It acts as the container for all data that can be on an annotation in a Publish PDF.

Public Functions

AnnotationKit ()

The default constructor creates an empty AnnotationKit object.

AnnotationKit (HPS.Publish.AnnotationKit in_kit)

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

Param in_kit

The source AnnotationKit to copy.

override void Dispose ()
override bool Empty ()

Indicates whether this AnnotationKit has any values set on it.

Return

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

bool Equals (HPS.Publish.AnnotationKit in_kit)

Check if the source AnnotationKit is equivalent to this AnnotationKit.

Param in_kit

The source AnnotationKit to compare to this AnnotationKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.AnnotationKit in_kit)

Copies the source AnnotationKit into this AnnotationKit.

Param in_kit

The source AnnotationKit to copy.

HPS.Publish.AnnotationKit SetActivation (HPS.Publish.Activation.When in_when)

Sets when the annotation is activated. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eActivateWhen.

Param in_when

When the annotation is activated.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetArtwork (HPS.Publish.ArtworkKit in_artwork)

Sets the artwork for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_p3DArtwork.

Param in_artwork

The artwork for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetBackgroundColor (HPS.RGBColor in_color)

Sets the background color for the annotation. Unused if there is a transparent background. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_sBackgroundColor.

Param in_color

The background color for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetBorderWidth (int in_width)

Sets the border width in points for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_iAppearanceBorderWidth.

Param in_width

The border width in points for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetCarouselButtons (string[] in_button_names, string in_previous_button_name, string in_next_button_name, ulong in_scroll_size)

Sets the carousel buttons for the annotation. This must be specified for a view carousel to be generated. This corresponds to the button names that will be passed to A3DPDFDefineViewCarousel.

Param in_button_names

Names for the view buttons in the carousel.

Param in_previous_button_name

UTF8-encoded name for the previous button.

Param in_next_button_name

UTF8-encoded name for the next button.

Param in_scroll_size

Number of buttons to scroll when the previous or next buttons are pressed.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetCarouselViews (ulong[] in_indices)

Sets the carousel views for the annotation. This can be optionally specified for a view carousel. This corresponds to the views and images that will be passed to A3DPDFDefineViewCarousel.

See

SetArtwork

See

ArtworkKit.SetViews

Param in_indices

Indices of the views on the associated ArtworkKit to use for the view carousel.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetCarouselViews (ulong[] in_indices, HPS.Publish.ImageKit[] in_images)

Sets the carousel views for the annotation. This can be optionally specified for a view carousel. This corresponds to the views and images that will be passed to A3DPDFDefineViewCarousel.

See

SetArtwork

See

ArtworkKit.SetViews

Param in_indices

Indices of the views on the associated ArtworkKit to use for the view carousel.

Param in_images

Images to use for the view carousel buttons. If unspecified, images will be generated from the views themselves.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetDeactivation (HPS.Publish.Deactivation.When in_when)

Sets when the annotation is deactivated. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eDesactiveWhen.

Param in_when

When the annotation is deactivated.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetFormat (HPS.Publish.Annotation.Format in_format)

Sets the format of the 3D data for the annotation.

Param in_format

The format of the 3D data for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetInteractivity (bool in_state)

Sets whether to enable interactivity on the annotation. This corresponds to the (negated) value that will be passed to A3DPDF3DAnnotData::m_bDisableInteractivity.

Param in_state

Whether to enable interactivity on the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetLighting (HPS.Publish.Lighting.Mode in_mode)

Sets the lighting mode for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eLighting.

Param in_mode

The lighting mode for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetModelTreeVisibility (bool in_state)

Sets whether to display the model tree when the annotation is activated. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_bOpenModelTree.

Param in_state

Whether to display the model tree when the annotation is activated.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetName (string in_name)

Sets the name for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_pcName.

Param in_name

UTF8-encoded name for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location)
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers)
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers, float[] in_columns)
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers, float[] in_columns, HPS.Publish.TextFieldKit in_text_style)
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers, float[] in_columns, HPS.Publish.TextFieldKit in_text_style, HPS.Publish.TextFieldKit in_header_text_style)
HPS.Publish.AnnotationKit SetPMIList (HPS.IntRectangle in_location, HPS.Publish.ListBoxKit in_list)

Creates a PMI List Box which contains a list of the PMI contained in the source file. Clicking on the entries of the list will highlight the associated PMI in the 3D annotation. The PMI List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC. If a View List or a View Carousel are also set on this annotation kit, the PMI List will only show the PMIs which are visible in the View you currently have selected in the PDF.

Param in_location

The location of the PMI List, specified in points relative to bottom left of the page. All fields in the location will be used.

Param in_list

The ListBoxKit used to specify the attributes of the PMI List.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetPMIListByField (string in_field)

Creates a PMI List Box which contains a list of the PMI contained in the source file. Clicking on the entries of the list will highlight the associated PMI in the 3D annotation. The PMI List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC. If a View List or a View Carousel are also set on this annotation kit, the PMI List will only show the PMIs which are visible in the View you currently have selected in the PDF.

Param in_field

UTF8-encoded form field name for the PMI List.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetPosterImage (HPS.Publish.ImageKit in_image)

Sets the poster image for the annotation. If this is not specified a poster image will be generated by Publish. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_pPosterImage.

Param in_image

The poster image for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetPRCAttributeRemoval (bool in_state)

Sets whether to remove the attribute information in the PRC data for this annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveAttributes.

Param in_state

Whether to remove the attribute information in the PRC data for this annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetPRCBRepCompression (HPS.Publish.PRC.BRepCompression in_level)

Sets the level of compression to apply to BRep data for a PRC annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the values that will be passed to A3DRWParamsExportPrcData::m_bCompressBrep and A3DRWParamsExportPrcData::m_eCompressBrepType.

Param in_level

The level of compression to apply to BRep data for a PRC annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetPRCBRepRemoval (bool in_state)

Sets whether to remove the BRep information in the PRC data for this annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveBRep.

Param in_state

Whether to remove BRep information in the PRC data for this annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetPRCTessellationCompression (bool in_state)

Sets whether to compress tessellation for a PRC annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bCompressTessellation.

Param in_state

Whether to compress tessellation for a PRC annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetRendering (HPS.Publish.Rendering.Mode in_mode)

Sets the rendering mode for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eRenderingStyle.

Param in_mode

The rendering mode for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetSource (HPS.CADModel in_cad_model)

Sets the source for the annotation to Annotation.SourceType.CADModel. This is the CADModel which contains the 3D data to be exported into the annotation

Param in_cad_model

The source CADModel for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetSource (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_sources)

Sets the source for the annotation to Annotation.SourceType.CADModelAndKeyPaths. These are the CADModel which will be used to export 3D data to the annotation, and the KeyPaths which will be added to the model

Param in_cad_model

The source CADModel for the annotation.

Param in_additional_sources

The additional source KeyPaths for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetSource (HPS.KeyPath in_source)

Sets the source for the annotation to Annotation.SourceType.KeyPaths. The Key Path that will be used to locate the 3D data for the annotation.

Param in_source

The source KeyPath for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetSource (HPS.KeyPath[] in_sources)

Sets the source for the annotation to Annotation.SourceType.KeyPaths. These are the KeyPaths that will be used to locate the 3D data for the annotation.

Param in_sources

The source KeyPaths for the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetToolbarVisibility (bool in_state)

Sets whether to display the toolbar when the annotation is activated. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_bShowToolbar.

Param in_state

Whether to display the toolbar when the annotation is activated.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetTransparentBackground (bool in_state)

Sets whether the annotation background is transparent. This will render background color irrelevant and has negative ramifications. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_bTransparentBackground.

Param in_state

Whether the annotation background is transparent.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetU3DCompression (byte in_level)

Sets the level of compression to apply to tessellations for a U3D annotation. If no compression level is set, no compression will be applied. This setting is only relevant if the format of the annotation is Annotation.Format.U3D. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_ucMeshQualityValue.

Param in_level

The level of compression to apply to tessellations for a U3D annotation. This value should be in the range [0, 100].

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetU3DVersion (HPS.Publish.U3D.Version in_version)

Sets the version of the data for a U3D annotation. This setting is only relevant if the format of the annotation is Annotation.Format.U3D. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_eU3DVersion.

Param in_version

The version of the data for a U3D annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetViewList (HPS.IntRectangle in_location, HPS.Publish.ListBoxKit in_list)

Creates a View List Box which contains a list of the Views contained in the source file. Clicking on the entries of the list will activate the associated View. The View List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC.

Param in_location

The location of the View List, specified in points relative to bottom left of the page. All fields in the location will be used.

Param in_list

The ListBoxKit used to specify the attributes of the View List.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit SetViewListByField (string in_field)

Creates a View List Box which contains a list of the Views contained in the source file. Clicking on the entries of the list will activate the associated View. The View List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC.

Param in_field

UTF8-encoded form field name for the View List.

Return

A reference to this AnnotationKit.

void Show (out HPS.Publish.AnnotationKit out_kit)

Copies this AnnotationKit into the given AnnotationKit.

Param out_kit

The AnnotationKit to populate with the contents of this AnnotationKit.

bool ShowActivation (out HPS.Publish.Activation.When out_when)

Shows the activation setting.

Param out_when

When the annotation is activated.

Return

true if an activation setting was specified, false otherwise.

bool ShowArtwork (out HPS.Publish.ArtworkKit out_artwork)

Shows the artwork setting.

Param out_artwork

The artwork for the annotation.

Return

true if an artwork was specified, false otherwise.

bool ShowBackgroundColor (out HPS.RGBColor out_color)

Shows the background color setting.

Param out_color

The background color for the annotation.

Return

true if a background color was specified, false otherwise.

bool ShowBorderWidth (out int out_width)

Shows the border width setting.

Param out_width

The border width of the annotation.

Return

true if a border width was specified, false otherwise.

bool ShowCarouselButtons (out string[] out_button_names, out string out_previous_button_name, out string out_next_button_name, out ulong out_scroll_size)
bool ShowCarouselViews (out ulong[] out_indices, out HPS.Publish.ImageKit[] out_images)

Shows the carousel views setting.

Param out_indices

Indices of the views on the associated ArtworkKit to use for the view carousel.

Param out_images

Images to use for the view carousel buttons. May be empty, even if out_indices is not.

Return

true if carousel views were specified, false otherwise.

bool ShowDeactivation (out HPS.Publish.Deactivation.When out_when)

Shows the deactivation setting.

Param out_when

When the annotation is deactivated.

Return

true if a deactivation setting was specified, false otherwise.

bool ShowFormat (out HPS.Publish.Annotation.Format out_format)

Shows the format setting.

Param out_format

The format of the 3D data for the annotation.

Return

true if a format was specified, false otherwise.

bool ShowInteractivity (out bool out_state)

Shows the interactivity setting.

Param out_state

Whether to enable interactivity on the annotation.

Return

true if an interactivity setting was specified, false otherwise.

bool ShowLighting (out HPS.Publish.Lighting.Mode out_mode)

Shows the lighting mode setting.

Param out_mode

The lighting mode for the annotation.

Return

true if a lighting mode was specified, false otherwise.

bool ShowModelTreeVisibility (out bool out_state)

Shows the model tree visibility setting.

Param out_state

Whether to display the model tree when the annotation is activated.

Return

true if a model tree visibility was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name setting.

Param out_name

The name for the annotation.

Return

true if a name was specified, false otherwise.

bool ShowPartsList (out ulong out_rows, out HPS.IntRectangle out_location, out string[] out_headers, out float[] out_columns, out HPS.Publish.TextFieldKit out_text_style, out HPS.Publish.TextFieldKit out_header_text_style)
bool ShowPMIList (out HPS.IntRectangle out_location, out HPS.Publish.ListBoxKit out_list)

Shows the PMI List setting.

Param out_location

The location of the PMI List table.

Param out_list

The options specified for the list box containing the PMI List

Return

true if a PMI List was specified, false otherwise.

bool ShowPMIListField (out string out_field)

Shows the PMI List setting.

Param out_field

The list box form field name on the page which will be used for the PMI List.

Return

true if a PMI List was specified by field, false otherwise.

bool ShowPosterImage (out HPS.Publish.ImageKit out_image)

Shows the poster image setting.

Param out_image

The poster image for the annotation.

Return

true if a poster image was specified, false otherwise.

bool ShowPRCAttributeRemoval (out bool out_state)

Shows the attribute removal for PRC data setting.

Param out_state

Whether to remove attribute information in the PRC data for this annotation.

Return

true if an attribute removal setting was specified, false otherwise.

bool ShowPRCBRepCompression (out HPS.Publish.PRC.BRepCompression out_level)

Shows the BRep compression level for PRC data setting.

Param out_level

The level of compression to apply to BRep data for a PRC annotation.

Return

true if a PRC BRep compression level setting was specified, false otherwise.

bool ShowPRCBRepRemoval (out bool out_state)

Shows the BRep removal for PRC data setting.

Param out_state

Whether to remove BRep information in the PRC data for this annotation.

Return

true if a BRep removal setting was specified, false otherwise.

bool ShowPRCTessellationCompression (out bool out_state)

Shows the tessellation compression for PRC data setting.

Param out_state

Whether to compress tessellation for a PRC annotation.

Return

true if a PRC tessellation compression setting was specified, false otherwise.

bool ShowRendering (out HPS.Publish.Rendering.Mode out_mode)

Shows the rendering mode setting.

Param out_mode

The rendering mode for the annotation.

Return

true if a rendering mode was specified, false otherwise.

bool ShowSource (out HPS.Publish.Annotation.SourceType out_source_type, out HPS.CADModel out_cad_model, out HPS.KeyPath[] out_key_paths)

Shows the source setting.

Param out_source_type

Specifies which one of the previous arguments is valid

Param out_cad_model

The source CADModel for the annotation. Only valid if out_source_type is CADModel or CADModelAndKeyPath

Param out_key_paths

The source KeyPath array for the annotation. Only valid if out_source_type is KeyPath or CADModelAndKeyPath

Return

true if a source was specified, false otherwise.

bool ShowToolbarVisibility (out bool out_state)

Shows the toolbar visibility setting.

Param out_state

Whether to display the toolbar when the annotation is activated.

Return

true if a toolbar visibility was specified, false otherwise.

bool ShowTransparentBackground (out bool out_state)

Shows the transparent background setting.

Param out_state

Whether the annotation has a transparent background.

Return

true if a transparent background setting specified, false otherwise.

bool ShowU3DCompression (out byte out_level)

Shows the compression level for U3D data for the annotation.

Param out_level

The level of compression to apply to tessellations for a U3D annotation.

Return

true if a U3D compression setting was specified, false otherwise.

bool ShowU3DVersion (out HPS.Publish.U3D.Version out_version)

Shows the version for U3D data setting.

Param out_version

The version of the data for a U3D annotation.

Return

true if a U3D version setting was specified, false otherwise.

bool ShowViewList (out HPS.IntRectangle out_location, out HPS.Publish.ListBoxKit out_list)

Shows the View List setting.

Param out_location

The location of the View List table.

Param out_list

The options specified for the list box containing the View List

Return

true if a View List was specified, false otherwise.

bool ShowViewListField (out string out_field)

Shows the View List setting.

Param out_field

The list box form field name on the page which will be used for the View List.

Return

true if a View List was specified by field, false otherwise.

HPS.Publish.AnnotationKit UnsetActivation ()

Removes the activation setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetArtwork ()

Removes the artwork setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetBackgroundColor ()

Removes the background color setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetBorderWidth ()

Removes the border width setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetCarouselButtons ()

Removes the carousel buttons setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetCarouselViews ()

Removes the carousel views setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetDeactivation ()

Removes the deactivation setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetEverything ()

Removes all data on the annotation.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetFormat ()

Removes the format setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetInteractivity ()

Removes the interactivity setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetLighting ()

Removes the lighting mode setting.a

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetModelTreeVisibility ()

Removes the model tree visibility setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetName ()

Removes the name setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetPartsList ()

Removes the Parts List setting.

Return

A reference to this AnnotationKit

HPS.Publish.AnnotationKit UnsetPMIList ()

Removes the PMI List setting.

Return

A reference to this AnnotationKit

HPS.Publish.AnnotationKit UnsetPosterImage ()

Removes the poster image setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetPRCAttributeRemoval ()

Removes the attribute removal for PRC data setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetPRCBRepCompression ()

Removes the BRep compression level for PRC data setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetPRCBRepRemoval ()

Removes the BRep removal for PRC data setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetPRCTessellationCompression ()

Removes the tessellation compression for PRC data setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetRendering ()

Removes the rendering mode setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetSource ()

Removes the source setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetToolbarVisibility ()

Removes the toolbar visibility setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetTransparentBackground ()

Removes the transparent background setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetU3DCompression ()

Removes the compression level for U3D data setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetU3DVersion ()

Removes the version for U3D data setting.

Return

A reference to this AnnotationKit.

HPS.Publish.AnnotationKit UnsetViewList ()

Removes the View List setting.

Return

A reference to this AnnotationKit

Public Static Functions

HPS.Publish.AnnotationKit GetDefault ()

Creates a AnnotationKit 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 AnnotationKit passed to File.Export.

Return

A AnnotationKit with the default settings.

bool operator!= (HPS.Publish.AnnotationKit a, HPS.Publish.AnnotationKit b)
bool operator== (HPS.Publish.AnnotationKit a, HPS.Publish.AnnotationKit b)
class Artwork : public IDisposable

The Publish.Artwork class is a concept class for artwork-related enumerations.

Public Functions

Artwork (HPS.Publish.Artwork in_that)
void Dispose ()
class Display : public IDisposable

The Publish.Artwork.Display class is a concept class for display-related artwork enumerations.

Public Types

enum Preference

Enumerates the preferences for the display of views in ArtworkKit objects.

Values:

Defined

Prefer the display settings (rendering mode, lighting mode, and background color) set in a view when activating it.

Runtime

Prefer the runtime display settings (rendering mode, lighting mode, and background color) in the application when activating a view (except for the default view).

Public Functions

Display (HPS.Publish.Artwork.Display in_that)
void Dispose ()
class View : public IDisposable

The Publish.Artwork.View class is a concept class for view-related artwork enumerations.

Public Types

enum Preference

Enumerates the preferences for default views in ArtworkKit objects.

Values:

Native

Prefer the native default view in the PRC data (if one is present).

PDF

Prefer the default view defined in the PDF (if one is present).

Public Functions

void Dispose ()
View (HPS.Publish.Artwork.View in_that)
class ArtworkKit : public HPS.SprocketKit

The ArtworkKit class is a user space object. It acts as the container for all data that can be on an artwork in a Publish PDF.

Public Functions

HPS.Publish.ArtworkKit AddView (HPS.Publish.ViewKit in_view)

Adds a view to the artwork. This will append the view to any existing views on the artwork. These correspond to values that will be passed to A3DPDF3DArtworkAddView.

Param in_view

The view to add to the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit AddViews (HPS.Publish.ViewKit[] in_views)

Adds views to the artwork. This will append the views to any existing views on the artwork. These correspond to values that will be passed to A3DPDF3DArtworkAddView.

Param in_views

The views to add to the artwork.

Return

A reference to this ArtworkKit.

ArtworkKit ()

The default constructor creates an empty ArtworkKit object.

ArtworkKit (HPS.Publish.ArtworkKit in_kit)

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

Param in_kit

The source ArtworkKit to copy.

override void Dispose ()
override bool Empty ()

Indicates whether this ArtworkKit has any values set on it.

Return

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

bool Equals (HPS.Publish.ArtworkKit in_kit)

Check if the source ArtworkKit is equivalent to this ArtworkKit.

Param in_kit

The source ArtworkKit to compare to this ArtworkKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.ArtworkKit in_kit)

Copies the source ArtworkKit into this ArtworkKit.

Param in_kit

The source ArtworkKit to copy.

HPS.Publish.ArtworkKit SetAnimationStyle (HPS.Publish.Animation.Style in_style)

Sets the animation style for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_eAnimationStyle.

Param in_style

The animation style for the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetDefaultViewPreference (HPS.Publish.Artwork.View.Preference in_preference)

Sets the default view preference for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bKeepNativeDefaultView.

Param in_preference

The default view preference for the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetDisplayPreference (HPS.Publish.Artwork.Display.Preference in_preference)

Sets the display preference for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bUseRuntimeDisplaySettings.

Param in_preference

The display preference for the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetJavaScript (string in_source)

Sets the JavaScript source or file for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_pcJavaScriptFileName.

Param in_source

The JavaScript source or file (depending on the next argument) for the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetJavaScript (string in_source, HPS.Publish.Source.Type in_type)

Sets the JavaScript source or file for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_pcJavaScriptFileName.

Param in_source

The JavaScript source or file (depending on the next argument) for the artwork.

Param in_type

The type of the preceding argument. Defaults to Source.Type.Code.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetPMIColor (HPS.RGBColor in_pmi_color)

Sets the PMI color for this artwork. This correspond to value that will be passed to A3DPDF3DArtworkData::m_sPMIColor .

Param in_pmi_color

The color to apply to PMIs for this artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetPMICrossHighlighting (bool in_state)

Sets the whether to enable PMI cross-highlighting for the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bActivatePMICrossHighlight.

Param in_state

Whether to highlight the geometry associated with a piece of PMI when that PMI is selected.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetPMISemanticInformation (bool in_state)

Sets the whether to include semantic PMI information in the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkData::m_bAddPMISemanticInformation.

Param in_state

Whether to include semantic PMI information in the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetView (HPS.Publish.ViewKit in_view)

Adds a view to the artwork. This will replace all views (if any) on the artwork. This corresponds to the value that will be passed to A3DPDF3DArtworkAddView.

Param in_view

The view to add to the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit SetViews (HPS.Publish.ViewKit[] in_views)

Adds views to the artwork. This will replace all views (if any) on the artwork. These correspond to values that will be passed to A3DPDF3DArtworkAddView.

Param in_views

The views to add to the artwork.

Return

A reference to this ArtworkKit.

void Show (out HPS.Publish.ArtworkKit out_kit)

Copies this ArtworkKit into the given ArtworkKit.

Param out_kit

The ArtworkKit to populate with the contents of this ArtworkKit.

bool ShowAnimationStyle (out HPS.Publish.Animation.Style out_style)

Shows the animation style setting.

Param out_style

The animation style of the artwork.

Return

true if an animation style was specified, false otherwise.

bool ShowDefaultViewPreference (out HPS.Publish.Artwork.View.Preference out_preference)

Shows the default view preference setting.

Param out_preference

The default view preference for the artwork.

Return

true if a default view preference was specified, false otherwise.

bool ShowDisplayPreference (out HPS.Publish.Artwork.Display.Preference out_preference)

Shows the display preference setting.

Param out_preference

The display preference for the artwork.

Return

true if a display preference was specified, false otherwise.

bool ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type)

Shows the JavaScript setting.

Param out_source

The JavaScript source or file (depending on the next argument) for the artwork.

Param out_type

The type of the preceding argument.

Return

true if a JavaScript source or file was specified, false otherwise.

bool ShowPMIColor (out HPS.RGBColor out_pmi_color)

Shows the PMI color for the artwork.

Param out_pmi_color

The PMI color for the artwork.

Return

true if a PMI color was specified, false otherwise.

bool ShowPMICrossHighlighting (out bool out_state)

Shows the PMI cross-highlighting setting.

Param out_state

Whether to highlight the geometry associated with a piece of PMI when that PMI is selected.

Return

true if a PMI cross-highlighting setting was specified, false otherwise.

bool ShowPMISemanticInformation (out bool out_state)

Shows the semantic PMI information setting.

Param out_state

Whether to include semantic PMI information in the artwork.

Return

true if a semantic PMI information setting was specified, false otherwise.

bool ShowViews (out HPS.Publish.ViewKit[] out_views)

Shows the views for the artwork.

Param out_views

The views for the artwork.

Return

true if views were specified, false otherwise.

HPS.Publish.ArtworkKit UnsetAnimationStyle ()

Removes the animation style setting.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetDefaultViewPreference ()

Removes the default view preference setting.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetDisplayPreference ()

Removes the display preference setting.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetEverything ()

Removes all data from the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetJavaScript ()

Removes the JavaScript setting.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetPMIColor ()

Removes the PMI color setting from the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetPMICrossHighlighting ()

Removes the PMI cross-highlighting setting.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetPMISemanticInformation ()

Removes the PMI semantic information setting.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetView (ulong in_index)

Removes the view at the given index from the artwork.

Param in_index

Index of the view to remove from the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetViews ()

Removes all views from the artwork.

Return

A reference to this ArtworkKit.

HPS.Publish.ArtworkKit UnsetViews (ulong[] in_indices)

Removes the views at the given indices from the artwork.

Param in_indices

Indices of the views to remove from the artwork.

Return

A reference to this ArtworkKit.

Public Static Functions

HPS.Publish.ArtworkKit GetDefault ()

Creates a ArtworkKit 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 ArtworkKit passed to File.Export.

Return

A ArtworkKit with the default settings.

bool operator!= (HPS.Publish.ArtworkKit a, HPS.Publish.ArtworkKit b)
bool operator== (HPS.Publish.ArtworkKit a, HPS.Publish.ArtworkKit b)
class Border : public IDisposable

The Publish.Border class is a concept class for border-related enumerations.

Public Types

enum Style

Enumerates the border styles.

Values:

Solid

Solid (kA3DPDFSolid)

Dashed

Dashed (kA3DPDFDashed)

Beveled

Beveled (kA3DPDFBeveled)

Inset

Inset (<a target=”_blank”.

Underlined

Underlined (kA3DPDFUnderlined)

enum Thickness

Enumerates the thicknesses for borders.

Values:

Thin

Thin border (kA3DPDFThin)

Medium

Medium border (kA3DPDFMedium)

Wide

Wide border (<a target=”_blank”.

Public Functions

Border (HPS.Publish.Border in_that)
void Dispose ()
class ButtonKit : public HPS.SprocketKit

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

Public Functions

ButtonKit ()

The default constructor creates an empty ButtonKit object.

ButtonKit (HPS.Publish.ButtonKit in_kit)

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

Param in_kit

The source ButtonKit to copy.

override void Dispose ()
override bool Empty ()

Indicates whether this ButtonKit has any values set on it.

Return

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

bool Equals (HPS.Publish.ButtonKit in_kit)

Check if the source ButtonKit is equivalent to this ButtonKit.

Param in_kit

The source ButtonKit to compare to this ButtonKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.ButtonKit in_kit)

Copies the source ButtonKit into this ButtonKit.

Param in_kit

The source ButtonKit to copy.

HPS.Publish.ButtonKit SetBorder (bool in_state)

Sets whether the button has a border. This corresponds to the value that will be passed to A3DPDFButtonData::m_bHasBorder.

Param in_state

Whether the button has a border.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetBorderColor (HPS.RGBColor in_color)

Sets the border color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sBorderColor.

Param in_color

The border color of the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetBorderStyle (HPS.Publish.Border.Style in_style)

Sets the border style for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLineStyleBorder.

Param in_style

The border style for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

Sets the border thickness for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eThicknessBorder.

Param in_thickness

The border thickness for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetFillColor (HPS.RGBColor in_color)

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

Param in_color

The fill color for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetFont (HPS.Publish.Text.Font.Name in_name)

Sets a builtin font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.

Param in_name

The builtin font for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetFont (string in_name)

Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.

Param in_name

UTF8-encoded font name for the button.

Return

A reference to this ButtonKit.

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

Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.

Param in_name

UTF8-encoded font name for the button.

Param in_style

The style of font to use for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetFontSize (int in_size)

Sets the font size for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_iFontSize.

Param in_size

The font size for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetHighlighting (HPS.Publish.Highlighting.Mode in_mode)

Sets the highlighting mode for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eHighlightingMode.

Param in_mode

The highlighting mode for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetIconImage (HPS.Publish.ImageKit in_image)

Sets the icon image for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pImage.

Param in_image

The icon image for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetLabel (string in_label)

Sets the label for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcLabel.

Param in_label

UTF8-encoded label for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetLabelPosition (HPS.Publish.Label.Position in_position)

Sets the label position for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLayoutTextIcon.

Param in_position

The label position for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetLock (bool in_state)

Sets whether the button is locked. This corresponds to the value that will be passed to A3DPDFButtonData::m_bIsLocked.

Param in_state

Whether the button is locked.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetName (string in_name)

Sets the name of the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcName.

Param in_name

UTF8-encoded name of the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetPrintability (bool in_state)

Sets the printability for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.

Param in_state

The printability for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetTextColor (HPS.RGBColor in_color)

Sets the text color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sTextColor.

Param in_color

The text color for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

Sets the text rotation for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eTextOrientation.

Param in_rotation

The text rotation for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetTooltip (string in_tooltip)

Sets the tooltip for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcTooltip.

Param in_tooltip

UTF8-encoded tooltip text for the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit SetVisibility (bool in_state)

Sets the visibility for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.

Param in_state

The visibility for the button.

Return

A reference to this ButtonKit.

void Show (out HPS.Publish.ButtonKit out_kit)

Copies this ButtonKit into the given ButtonKit.

Param out_kit

The ButtonKit to populate with the contents of this ButtonKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the button.

Param out_state

Whether the button has a border.

Return

true if a border setting was specified, false otherwise.

bool ShowBorderColor (out HPS.RGBColor out_color)

Shows the border color for the button.

Param out_color

The border color of the button.

Return

true if a border color was specified, false otherwise.

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

Shows the border style for the button.

Param out_style

The border style for the button.

Return

true if a border style was specified, false otherwise.

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

Shows the border thickness for the button.

Param out_thickness

The border thickness for the button.

Return

true if a border thickness was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the button.

Param out_color

The fill color for the button.

Return

true if a fill color was specified, false otherwise.

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 button.

Param out_type

The type of font for the button.

Param out_font

The built-in font for the button. This is only valid if out_type is Text.Font.Type.BuiltIn.

Param out_font_name

The explicit font name for the button. This is only valid if out_type is Text.Font.Type.Explicit.

Param out_style

The font style for the button. This is only valid if out_type is Text.Font.Type.Explicit.

Return

true if a font was specified, false otherwise.

bool ShowFontSize (out int out_size)

Shows the font size for the button.

Param out_size

The font size for the button.

Return

true if a font size was specified, false otherwise.

bool ShowHighlighting (out HPS.Publish.Highlighting.Mode out_mode)

Shows the highlighting mode for the button.

Param out_mode

The highlighting mode for the button.

Return

true if a highlighting mode was specified, false otherwise.

bool ShowIconImage (out HPS.Publish.ImageKit out_image)

Shows the icon image for the button.

Param out_image

The icon image for the button.

Return

true if an icon image was specified, false otherwise.

bool ShowLabel (out string out_label)

Shows the label for the button.

Param out_label

The label for the button.

Return

true if a label was specified, false otherwise.

bool ShowLabelPosition (out HPS.Publish.Label.Position out_position)

Shows the label position for the button.

Param out_position

The label position for the button.

Return

true if a label position was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the button.

Return

true if a lock setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the button.

Param out_name

The name of the button.

Return

true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the button.

Param out_state

The printability for the button.

Return

true if a printability was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the button.

Param out_color

The text color for the button.

Return

true if a text color was specified, false otherwise.

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

Shows the text rotation for the button.

Param out_rotation

The text rotation for the button.r

Return

true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the button.

Param out_tooltip

The tooltip text for the button.

Return

true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the button.

Param out_state

The visibility for the button.

Return

true if a visibility was specified, false otherwise.

HPS.Publish.ButtonKit UnsetBorder ()

Removes the border setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetBorderColor ()

Removes the border color setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetBorderStyle ()

Removes the border style setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetBorderThickness ()

Removes the border thickness setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetEverything ()

Removes all data from the button.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetFillColor ()

Removes the fill color setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetFont ()

Removes the font setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetFontSize ()

Removes the font size setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetHighlighting ()

Removes the highlighting mode setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetIconImage ()

Removes the icon image setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetLabel ()

Removes the label setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetLabelPosition ()

Removes the label position setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetLock ()

Removes the lock setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetName ()

Removes the name setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetPrintability ()

Removes the printability setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetTextColor ()

Removes the text color setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetTextRotation ()

Removes the text rotation setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetTooltip ()

Removes the tooltip setting.

Return

A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetVisibility ()

Removes the visibility setting.

Return

A reference to this ButtonKit.

Public Static Functions

HPS.Publish.ButtonKit GetDefault ()

Creates a ButtonKit 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 ButtonKit passed to a function.

Return

A ButtonKit with the default settings.

bool operator!= (HPS.Publish.ButtonKit a, HPS.Publish.ButtonKit b)
bool operator== (HPS.Publish.ButtonKit a, HPS.Publish.ButtonKit b)
class CheckBoxKit : public HPS.SprocketKit

The CheckBoxKit class is a user space object. It acts as the container for all data that can be used to specify a check box for a Publish PDF.

Public Functions

CheckBoxKit ()

The default constructor creates an empty CheckBoxKit object.

CheckBoxKit (HPS.Publish.CheckBoxKit in_kit)

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

Param in_kit

The source CheckBoxKit to copy.

override void Dispose ()
override bool Empty ()

Indicates whether this CheckBoxKit has any values set on it.

Return

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

bool Equals (HPS.Publish.CheckBoxKit in_kit)

Check if the source CheckBoxKit is equivalent to this CheckBoxKit.

Param in_kit

The source CheckBoxKit to compare to this CheckBoxKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.CheckBoxKit in_kit)

Copies the source CheckBoxKit into this CheckBoxKit.

Param in_kit

The source CheckBoxKit to copy.

HPS.Publish.CheckBoxKit SetBorder (bool in_state)

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

Param in_state

Whether the check box has a border.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetBorderColor (HPS.RGBColor in_color)

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

Param in_color

The border color of the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetBorderStyle (HPS.Publish.Border.Style in_style)

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

Param in_style

The border style for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

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

Param in_thickness

The border thickness for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetDefaultState (bool in_state)

Sets whether the check box is checked by default. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsCheckedByDefault.

Param in_state

Whether the check box is checked by default.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetExportValue (string in_export_value)

Sets the export value used when field data is exported by Acrobat functions. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcExportValue.

Param in_export_value

UTF8-encoded export value of the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetFillColor (HPS.RGBColor in_color)

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

Param in_color

The fill color for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetFont (HPS.Publish.Text.Font.Name in_name)

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

Param in_name

The builtin font for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetFont (string in_name)

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

Param in_name

UTF8-encoded font name for the check box.

Return

A reference to this CheckBoxKit.

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

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

Param in_name

UTF8-encoded font name for the check box.

Param in_style

The style of font to use for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetFontSize (int in_size)

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

Param in_size

The font size for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetLock (bool in_state)

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

Param in_state

Whether the check box is locked.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetName (string in_name)

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

Param in_name

UTF8-encoded name of the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetPrintability (bool in_state)

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

Param in_state

The printability for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetTextColor (HPS.RGBColor in_color)

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

Param in_color

The text color for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

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

Param in_rotation

The text rotation for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetTooltip (string in_tooltip)

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

Param in_tooltip

UTF8-encoded tooltip text for the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit SetVisibility (bool in_state)

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

Param in_state

The visibility for the check box.

Return

A reference to this CheckBoxKit.

void Show (out HPS.Publish.CheckBoxKit out_kit)

Copies this CheckBoxKit into the given CheckBoxKit.

Param out_kit

The CheckBoxKit to populate with the contents of this CheckBoxKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the check box.

Param out_state

Whether the check box has a border.

Return

true if a border setting was specified, false otherwise.

bool ShowBorderColor (out HPS.RGBColor out_color)

Shows the border color for the check box.

Param out_color

The border color of the check box.

Return

true if a border color was specified, false otherwise.

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

Shows the border style for the check box.

Param out_style

The border style for the check box.

Return

true if a border style was specified, false otherwise.

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

Shows the border thickness for the check box.

Param out_thickness

The border thickness for the check box.

Return

true if a border thickness was specified, false otherwise.

bool ShowDefaultState (out bool out_default_state)

Shows the default state for the check box.

Param out_default_state

The default state for the check box.

Return

true if a default state was specified, false otherwise.

bool ShowExportValue (out string out_export_value)

Shows the export value for the check box.

Param out_export_value

The export value for the check box.

Return

true if an export value was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the check box.

Param out_color

The fill color for the check box.

Return

true if a fill color was specified, false otherwise.

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 check box.

Param out_type

The type of font for the check box.

Param out_font

The built-in font for the check box. This is only valid if out_type is Text.Font.Type.BuiltIn.

Param out_font_name

The explicit font name for the check box. This is only valid if out_type is Text.Font.Type.Explicit.

Param out_style

The font style for the check box. This is only valid if out_type is Text.Font.Type.Explicit.

Return

true if a font was specified, false otherwise.

bool ShowFontSize (out int out_size)

Shows the font size for the check box.

Param out_size

The font size for the check box.

Return

true if a font size was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the check box.

Return

true if a lock setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the check box.

Param out_name

The name of the check box.

Return

true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the check box.

Param out_state

The printability for the check box.

Return

true if a printability was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the check box.

Param out_color

The text color for the check box.

Return

true if a text color was specified, false otherwise.

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

Shows the text rotation for the check box.

Param out_rotation

The text rotation for the check box.

Return

true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the check box.

Param out_tooltip

The tooltip text for the check box.

Return

true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the check box.

Param out_state

The visibility for the check box.

Return

true if a visibility was specified, false otherwise.

HPS.Publish.CheckBoxKit UnsetBorder ()

Removes the border setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetBorderColor ()

Removes the border color setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetBorderStyle ()

Removes the border style setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetBorderThickness ()

Removes the border thickness setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetDefaultState ()

Removes the default state setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetEverything ()

Removes all data from the check box.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetExportValue ()

Removes the export value setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetFillColor ()

Removes the fill color setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetFont ()

Removes the font setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetFontSize ()

Removes the font size setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetLock ()

Removes the lock setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetName ()

Removes the name setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetPrintability ()

Removes the printability setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetTextColor ()

Removes the text color setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetTextRotation ()

Removes the text rotation setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetTooltip ()

Removes the tooltip setting.

Return

A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetVisibility ()

Removes the visibility setting.

Return

A reference to this CheckBoxKit.

Public Static Functions

HPS.Publish.CheckBoxKit GetDefault ()

Creates a CheckBoxKit 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 CheckBoxKit passed to a function.

Return

A CheckBoxKit with the default settings.

bool operator!= (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit b)
bool operator== (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit b)
class DataTableKit : public HPS.SprocketKit

The DataTableKit class is a user space object. It acts as the container for all data that can be used to specify a Data Table for a Publish PDF.

Public Functions

DataTableKit ()

The default constructor creates an empty DataTableKit object.

DataTableKit (HPS.Publish.DataTableKit in_kit)

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

Param in_kit

The source DataTableKit to copy.

override void Dispose ()
override bool Empty ()

Indicates whether this DataTableKit has any values set on it.

Return

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

bool Equals (HPS.Publish.DataTableKit in_kit)

Check if the source DataTableKit is equivalent to this DataTableKit.

Param in_kit

The source DataTableKit to compare to this DataTableKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.DataTableKit in_kit)

Copies the source DataTableKit into this DataTableKit.

Param in_kit

The source DataTableKit to copy.

HPS.Publish.DataTableKit SetColumns (uint in_value)

Sets the number of columns for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData.m_iNbCols.

Param in_value

The number of columns of theData Table.

Return

A reference to this DataTableKit.

HPS.Publish.DataTableKit SetData (string[][] in_value)
HPS.Publish.DataTableKit SetRows (uint in_value)

Sets the number of rows for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData.m_iNbRows.

Param in_value

The number of rows of theData Table.

Return

A reference to this DataTableKit.

void Show (out HPS.Publish.DataTableKit out_kit)

Copies this DataTableKit into the given DataTableKit.

Param out_kit

The DataTableKit to populate with the contents of this DataTableKit.

bool ShowColumns (out uint out_number)

Shows the number of columns of the DataTable.

Param out_number

The number of columns of the DataTable.

Return

true if a number of columns was specified, false otherwise.

bool ShowData (out string[][] out_data)
bool ShowRows (out uint out_number)

Shows the number of rows of the DataTable.

Param out_number

The number of rows of the DataTable.

Return

true if a number of rows was specified, false otherwise.

HPS.Publish.DataTableKit UnsetColumns ()

Removes the columns setting.

Return

A reference to this DataTableKit.

HPS.Publish.DataTableKit UnsetData ()

Removes the Data setting.

Return

A reference to this DataTableKit.

HPS.Publish.DataTableKit UnsetRows ()

Removes the rows setting.

Return

A reference to this DataTableKit.

Public Static Functions

HPS.Publish.DataTableKit GetDefault ()

Creates a DataTableKit 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 DataTableKit passed to a function.

Return

A DataTableKit with the default settings.

bool operator!= (HPS.Publish.DataTableKit a, HPS.Publish.DataTableKit b)
bool operator== (HPS.Publish.DataTableKit a, HPS.Publish.DataTableKit b)
class Deactivation : public IDisposable

The Publish.Deactivation class is a concept class for deactivation-related enumeration.

Public Types

enum When

Enumerates when an annotation is deactivated.

Values:

Explicit

Annotation is not deactivated until a script or the user explcitly deactivate it (kA3DPDFActivExplicitDesactivation).

Closed

Annotation is deactivated as soon as the page containing it is closed (<a target=”_blank”.

NotVisible

Annotation is deactivated as soon as the page containing it is no longer visible (kA3DPDFActivPageNotVisible).

Public Functions

Deactivation (HPS.Publish.Deactivation in_that)
void Dispose ()
class DocumentKey : public HPS.Sprocket

The DocumentKey class is a smart pointer to a Publish PDF document. It allows direct interaction with a PDF document.

Public Functions

HPS.Publish.DocumentKey AddAttachment (string in_filename, string in_description)

Adds an attachment to the document. If there is an existing attachment on the document with the given filename, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddFileAttachment.

Param in_filename

UTF8-encoded filename of the file to be attached.

Param in_description

UTF8-encoded description of the file to be attached.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddAttachments (string[] in_filenames, string[] in_descriptions)

Adds a list of attachments to the document. If there is an existing attachment on the document with a filename which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddFileAttachment.

Param in_filenames

Filenames of the files to be attached.

Param in_descriptions

Descriptions of the files to be attached.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddIconImage (string in_name, HPS.Publish.ImageKit in_image)

Adds an icon image to the document. If there is an existing icon image on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddImageAsIcon.

Param in_name

UTF8-encoded name of the icon image to be attached.

Param in_image

Image to be attached as an icon.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddIconImages (string[] in_names, HPS.Publish.ImageKit[] in_images)

Adds icon images to the document. If there is an existing icon image on the document with a name which is in the given list, it will get overwritten. These correspond to the values that will be passed to A3DPDFDocumentAddImageAsIcon.

Param in_names

Names of the icon images to be attached.

Param in_images

Images to be attached as icons.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddJavaScript (string in_script_name, string in_source)

Adds a named JavaScript source or file to the document. If there is an existing script on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddJavascriptFromString.

Param in_script_name

UTF8-encoded script name to be added to the document.

Param in_source

UTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddJavaScript (string in_script_name, string in_source, HPS.Publish.Source.Type in_type)

Adds a named JavaScript source or file to the document. If there is an existing script on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddJavascriptFromString.

Param in_script_name

UTF8-encoded script name to be added to the document.

Param in_source

UTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.

Param in_type

The types of the preceding argument. Defaults to Source.Type.Code.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddJavaScript (string[] in_script_names, string[] in_sources, HPS.Publish.Source.Type[] in_types)

Adds a list of named JavaScript sources or files to the document. If there is an existing script on the document with a name which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddJavascriptFromString.

Param in_script_names

Script names to be added to the document.

Param in_sources

JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document.

Param in_types

Types for each item in the preceding argument array.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddPage (HPS.Publish.PageKit in_page)

Adds the given page to the document. This will append the page after any existing pages on the document. This corresponds to the value that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Param in_page

Page to add to the document.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey AddPages (HPS.Publish.PageKit[] in_pages)

Adds the given pages to the document. This will append the pages after any existing pages on the document. These correspond to values that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Param in_pages

Pages to add to the document.

Return

A reference to this DocumentKey.

void Assign (HPS.Publish.DocumentKey in_that)

Share the underlying smart-pointer of the DocumentKey source.

Param in_that

The DocumentKey source of the assignment.

Return

A reference to this DocumentKey.

void Delete ()

Closes the PDF document underlying this DocumentKey and frees the associated memory in Publish. This will effectively invalidate all references to the underlying PDF document (including other DocumentKey or PageControl objects which refer to the same document). This will not write the underlying PDF document out to disk.

override void Dispose ()
DocumentKey ()

The default constructor creates an uninitialized DocumentKey object. The Type() function will return Type.None.

DocumentKey (HPS.Publish.DocumentKey in_that)

The copy constructor creates a DocumentKey object that shares the underlying smart-pointer of the source DocumentKey.

Param in_that

The source DocumentKey to copy.

bool Equals (HPS.Publish.DocumentKey in_that)

Check if the source DocumentKey points to the same underlying impl as this DocumentKey.

Param in_that

The source DocumentKey to compare to this DocumentKey.

Return

true if the objects reference the same impl, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
HPS.Publish.PageControl GetPageControl (ulong in_index)

Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document.

Param in_index

The index of the page for which to create a PageControl. The index of the first page is 0.

Return

A PageControl object for the specified page.

ulong GetPageCount ()

Gets the number of pages in the underlying PDF document.

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

HPS.Publish.DocumentKey RemoveAllPages ()

Removes all pages from the underlying PDF document.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey RemovePage (ulong in_index)

Removes the page at the given index from the underlying PDF document.

Param in_index

The index of the page to remove from the underlying PDF document. The index of the first page is 0.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey RemovePages (ulong in_start, ulong in_count)

Removes the specified number of pages starting at the given index from the underlying PDF document.

Param in_start

The first index at which to start to removing pages from the underlying PDF document. The index of the first page is 0.

Param in_count

The number of pages to remove from the underlying PDF document.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey RemovePages (ulong[] in_indices)

Removes the pages at the given indices from the underlying PDF document.

Param in_indices

The indices of pages to remove from the underlying PDF document. The index of the first page is 0.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey SetInformation (string in_title, string in_author, string in_subject, string in_creator)

Sets the title, author, subject and creator for this document. These corresponds to the values that will be passed to A3DPDFDocumentInformationData::m_pcTitle, A3DPDFDocumentInformationData::m_pcAuthor, A3DPDFDocumentInformationData::m_pcSubject, and A3DPDFDocumentInformationData::m_pcCreator (respectively).

Param in_title

UTF8-encoded title string to set on the document.

Param in_author

UTF8-encoded author string to set on the document.

Param in_subject

UTF8-encoded subject string to set on the document.

Param in_creator

UTF8-encoded creator string to set on the document.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey SetPasswords (string in_user_password, string in_owner_password)

Sets the passwords for this document. This corresponds to the value that will be passed to A3DPDFDocumentSetPassword.

Param in_user_password

UTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required.

Param in_owner_password

UTF8-encoded password string required when changing security features of document. If an empty string is specified, no password will be required.

Return

A reference to this DocumentKey.

HPS.Publish.DocumentKey SetPermissions (HPS.Publish.Permission.Type[] in_permissions)

Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.

Param in_permissions

The permissions to be set on the document.

Return

A reference to this DocumentKey.

Public Static Functions

bool operator!= (HPS.Publish.DocumentKey a, HPS.Publish.DocumentKey b)
bool operator== (HPS.Publish.DocumentKey a, HPS.Publish.DocumentKey b)
class DocumentKit : public HPS.SprocketKit

The DocumentKit class is a user space object. It acts as the root container for all pages in a Publish PDF.

Public Functions

HPS.Publish.DocumentKit AddAttachment (string in_filename, string in_description)

Adds an attachment to the document. If there is an existing attachment on the document with the given filename, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddFileAttachment.

Param in_filename

UTF8-encoded filename of the file to be attached.

Param in_description

UTF8-encoded description of the file to be attached.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddAttachments (string[] in_filenames, string[] in_descriptions)

Adds a list of attachments to the document. If there is an existing attachment on the document with a filename which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddFileAttachment.

Param in_filenames

Filenames of the files to be attached.

Param in_descriptions

Descriptions of the files to be attached.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddDataTable (HPS.Publish.DataTableKit in_data_table)

Adds an data table to the document.

Param in_data_table

Data Table to be added into the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddDataTables (HPS.Publish.DataTableKit[] in_data_table)

Adds data tables to the document.

Param in_data_table

Data Tables to be added into the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddIconImage (string in_name, HPS.Publish.ImageKit in_image)

Adds an icon image to the document. If there is an existing icon image on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddImageAsIcon.

Param in_name

UTF8-encoded name of the icon image to be attached.

Param in_image

Image to be attached as an icon.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddIconImages (string[] in_names, HPS.Publish.ImageKit[] in_images)

Adds icon images to the document. If there is an existing icon image on the document with a name which is in the given list, it will get overwritten. These correspond to the values that will be passed to A3DPDFDocumentAddImageAsIcon.

Param in_names

Names of the icon images to be attached.

Param in_images

Images to be attached as icons.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddJavaScript (string in_script_name, string in_source)

Adds a named JavaScript source or file to the document. If there is an existing script on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddJavascriptFromString.

Param in_script_name

UTF8-encoded script name to be added to the document.

Param in_source

UTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddJavaScript (string in_script_name, string in_source, HPS.Publish.Source.Type in_type)

Adds a named JavaScript source or file to the document. If there is an existing script on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddJavascriptFromString.

Param in_script_name

UTF8-encoded script name to be added to the document.

Param in_source

UTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.

Param in_type

The types of the preceding argument. Defaults to Source.Type.Code.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddJavaScript (string[] in_script_names, string[] in_sources, HPS.Publish.Source.Type[] in_types)

Adds a list of named JavaScript sources or files to the document. If there is an existing script on the document with a name which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddJavascriptFromString.

Param in_script_names

Script names to be added to the document.

Param in_sources

JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document.

Param in_types

Types for each item in the preceding argument array.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddPage (HPS.Publish.PageKit in_page)

Adds the given page to the document. This will append the page after any existing pages on the document. This corresponds to the value that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Param in_page

Page to add to the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit AddPages (HPS.Publish.PageKit[] in_pages)

Adds the given pages to the document. This will append the pages after any existing pages on the document. These correspond to values that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Param in_pages

Pages to add to the document.

Return

A reference to this DocumentKit.

override void Dispose ()
DocumentKit ()

The default constructor creates an empty DocumentKit object.

DocumentKit (HPS.Publish.DocumentKit in_kit)

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

Param in_kit

The source DocumentKit to copy.

override bool Empty ()

Indicates whether this DocumentKit has any values set on it.

Return

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

bool Equals (HPS.Publish.DocumentKit in_kit)

Check if the source DocumentKit is equivalent to this DocumentKit.

Param in_kit

The source DocumentKit to compare to this DocumentKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.DocumentKit in_kit)

Copies the source DocumentKit into this DocumentKit.

Param in_kit

The source DocumentKit to copy.

HPS.Publish.DocumentKit SetInformation (string in_title, string in_author, string in_subject, string in_creator)

Sets the title, author, subject and creator for this document. These corresponds to the values that will be passed to A3DPDFDocumentInformationData::m_pcTitle, A3DPDFDocumentInformationData::m_pcAuthor, A3DPDFDocumentInformationData::m_pcSubject, and A3DPDFDocumentInformationData::m_pcCreator (respectively).

Param in_title

UTF8-encoded title string to set on the document.

Param in_author

UTF8-encoded author string to set on the document.

Param in_subject

UTF8-encoded subject string to set on the document.

Param in_creator

UTF8-encoded creator string to set on the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit SetPage (HPS.Publish.PageKit in_page)

Adds the given page to the document. This will replace all pages (if any) which are already on the document. This corresponds to the value that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Param in_page

Page to add to the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit SetPages (HPS.Publish.PageKit[] in_pages)

Adds the given pages to the document. This will replace all pages (if any) which are already on the document. These correspond to values that will be passed to A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.

Param in_pages

Pages to add to the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit SetPasswords (string in_user_password, string in_owner_password)

Sets the passwords for this document. This corresponds to the value that will be passed to A3DPDFDocumentSetPassword.

Param in_user_password

UTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required.

Param in_owner_password

UTF8-encoded password string required when changing security features of document. If an empty string is specified, no password will be required.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit SetPermissions (HPS.Publish.Permission.Type[] in_permissions)

Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.

Param in_permissions

The permissions to be set on the document.

Return

A reference to this DocumentKit.

void Show (out HPS.Publish.DocumentKit out_kit)

Copies this DocumentKit into the given DocumentKit.

Param out_kit

The DocumentKit to populate with the contents of this DocumentKit.

bool ShowAttachments (out string[] out_filenames, out string[] out_descriptions)
bool ShowDataTables (out HPS.Publish.DataTableKit[] out_data_tables)

Shows data tables on the document

Param out_data_tables

Data tables on the document.

Return

true if data tables were set, false otherwise.

bool ShowIconImages (out string[] out_names, out HPS.Publish.ImageKit[] out_images)
bool ShowInformation (out string out_title, out string out_author, out string out_subject, out string out_creator)

Shows the document title, author, subject and creator.

Param out_title

Title of the document

Param out_author

Author of the document

Param out_subject

Subject of the document

Param out_creator

Creator of the document

Return

true if a title, author, subject and creator were specified, false otherwise.

bool ShowJavaScript (out string[] out_script_names, out string[] out_sources, out HPS.Publish.Source.Type[] out_types)
bool ShowPages (out HPS.Publish.PageKit[] out_pages)

Shows the pages on the document.

Param out_pages

Pages on the document.

Return

true if pages were specified, false otherwise.

bool ShowPasswords (out string out_user_password, out string out_owner_password)

Shows the document passwords.

Param out_user_password

User password of the document.

Param out_owner_password

Owner password of the document.

Return

true if passwords were specified, false otherwise.

bool ShowPermissions (out HPS.Publish.Permission.Type[] out_permissions)

Shows permissions on the document

Param out_permissions

Permissions on the document.

Return

true if permissions were specified, false otherwise.

HPS.Publish.DocumentKit UnsetAttachment (string in_filename)

Removes the attachment with a given filename from the document.

Param in_filename

UTF8-encoded filename of attachment to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetAttachments ()

Removes all attachments from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetAttachments (string[] in_filenames)

Removes the attachments with the given filenames from the document.

Param in_filenames

Filenames of attachments to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetDatatables ()

Removes Data Table settings from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetEverything ()

Removes all data from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetIconImage (string in_name)

Removes the icon image with a given name from the document.

Param in_name

UTF8-encoded name of icon image to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetIconImages ()

Removes all icon images from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetIconImages (string[] in_names)

Removes the icon images with the given names from the document.

Param in_names

Names of icon images to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetInformation ()

Removes the document title, author, subject and creator.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetJavaScript ()

Removes all scripts from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetJavaScript (string in_script_name)

Removes the script with a given name from the document.

Param in_script_name

UTF8-encoded script name to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetJavaScript (string[] in_script_names)

Removes the scripts with the given names from the document.

Param in_script_names

Script names to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetPage (ulong in_index)

Removes the page at the given index from the document.

Param in_index

Index of the page to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetPages ()

Removes all pages from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetPages (ulong[] in_indices)

Removes the pages at the given indices from the document.

Param in_indices

Indices of the pages to remove from the document.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetPasswords ()

Removes the document passwords.

Return

A reference to this DocumentKit.

HPS.Publish.DocumentKit UnsetPermissions ()

Removes permission settings from the document.

Return

A reference to this DocumentKit.

Public Static Functions

HPS.Publish.DocumentKit GetDefault ()

Creates a DocumentKit 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 DocumentKit passed to File.Export.

Return

A DocumentKit with the default settings.

bool operator!= (HPS.Publish.DocumentKit a, HPS.Publish.DocumentKit b)
bool operator== (HPS.Publish.DocumentKit a, HPS.Publish.DocumentKit b)
class DropDownListKit : public HPS.SprocketKit

The DropDownListKit class is a user space object. It acts as the container for all data that can be used to specify a drop down list for a Publish PDF.

Public Functions

override void Dispose ()
DropDownListKit ()

The default constructor creates an empty DropDownListKit object.

DropDownListKit (HPS.Publish.DropDownListKit in_kit)

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

Param in_kit

The source DropDownListKit to copy.

override bool Empty ()

Indicates whether this DropDownListKit has any values set on it.

Return

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

bool Equals (HPS.Publish.DropDownListKit in_kit)

Check if the source DropDownListKit is equivalent to this DropDownListKit.

Param in_kit

The source DropDownListKit to compare to this DropDownListKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.DropDownListKit in_kit)

Copies the source DropDownListKit into this DropDownListKit.

Param in_kit

The source DropDownListKit to copy.

HPS.Publish.DropDownListKit SetBorder (bool in_state)

Sets whether the drop down list has a border. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bHasBorder.

Param in_state

Whether the drop down list has a border.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetBorderColor (HPS.RGBColor in_color)

Sets the border color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sBorderColor.

Param in_color

The border color of the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetBorderStyle (HPS.Publish.Border.Style in_style)

Sets the border style for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eLineStyleBorder.

Param in_style

The border style for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

Sets the border thickness for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eThicknessBorder.

Param in_thickness

The border thickness for the drop down list.

Return

A reference to this DropDownListKit.

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

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

Param in_displayed_values

The values displayed in the drop down list

Param in_export_values

The export values associated with the values displayed

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetCustomText (bool in_state)

Sets whether the user can enter custom text. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bAllowUserToEnterCustomText.

Param in_state

Whether the user can enter custom text.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFillColor (HPS.RGBColor in_color)

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

Param in_color

The fill color for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFont (HPS.Publish.Text.Font.Name in_name)

Sets a builtin font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.

Param in_name

The builtin font for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFont (string in_name)

Sets a specific font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.

Param in_name

UTF8-encoded font name for the drop down list.

Return

A reference to this DropDownListKit.

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

Sets a specific font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.

Param in_name

UTF8-encoded font name for the drop down list.

Param in_style

The style of font to use for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFontSize (int in_size)

Sets the font size for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_iFontSize.

Param in_size

The font size for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetImmediateCommit (bool in_state)

Sets whether selected values are committed immediately. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCommitImmediate.

Param in_state

Whether selected values are committed immediately.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetLock (bool in_state)

Sets whether the drop down list is locked. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bIsLocked.

Param in_state

Whether the drop down list is locked.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetName (string in_name)

Sets the name of the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcName.

Param in_name

UTF8-encoded name of the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetPrintability (bool in_state)

Sets the printability for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eFormField.

Param in_state

The printability for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetSpellChecking (bool in_state)

Sets whether spell checking is enabled. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCheckSpelling.

Param in_state

Whether spell checking is enabled.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetTextColor (HPS.RGBColor in_color)

Sets the text color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sTextColor.

Param in_color

The text color for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

Sets the text rotation for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eTextOrientation.

Param in_rotation

The text rotation for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetTooltip (string in_tooltip)

Sets the tooltip for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcTooltip.

Param in_tooltip

UTF8-encoded tooltip text for the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetVisibility (bool in_state)

Sets the visibility for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eFormField.

Param in_state

The visibility for the drop down list.

Return

A reference to this DropDownListKit.

void Show (out HPS.Publish.DropDownListKit out_kit)

Copies this DropDownListKit into the given DropDownListKit.

Param out_kit

The DropDownListKit to populate with the contents of this DropDownListKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the drop down list.

Param out_state

Whether the drop down list has a border.

Return

true if a border setting was specified, false otherwise.

bool ShowBorderColor (out HPS.RGBColor out_color)

Shows the border color for the drop down list.

Param out_color

The border color of the drop down list.

Return

true if a border color was specified, false otherwise.

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

Shows the border style for the drop down list.

Param out_style

The border style for the drop down list.

Return

true if a border style was specified, false otherwise.

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

Shows the border thickness for the drop down list.

Param out_thickness

The border thickness for the drop down list.

Return

true if a border thickness was specified, false otherwise.

bool ShowContents (out string[] out_displayed_values, out string[] out_export_values)
bool ShowCustomText (out bool out_state)

Shows the custom text setting for the drop down list.

Param out_state

Whether the user can enter custom text.

Return

true if a custom text setting was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the drop down list.

Param out_color

The fill color for the drop down list.

Return

true if a fill color was specified, false otherwise.

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 drop down list.

Param out_type

The type of font for the drop down list.

Param out_font

The built-in font for the drop down list. This is only valid if out_type is Text.Font.Type.BuiltIn.

Param out_font_name

The explicit font name for the drop down list. This is only valid if out_type is Text.Font.Type.Explicit.

Param out_style

The font style for the drop down list. This is only valid if out_type is Text.Font.Type.Explicit.

Return

true if a font was specified, false otherwise.

bool ShowFontSize (out int out_size)

Shows the font size for the drop down list.

Param out_size

The font size for the drop down list.

Return

true if a font size was specified, false otherwise.

bool ShowImmediateCommit (out bool out_state)

Shows the immediate commit setting for the drop down list.

Param out_state

Whether selected values are committed immediately.

Return

true if an immediate commit setting was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the drop down list.

Return

true if a lock setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the drop down list.

Param out_name

The name of the drop down list.

Return

true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the drop down list.

Param out_state

The printability for the drop down list.

Return

true if a printability was specified, false otherwise.

bool ShowSpellChecking (out bool out_state)

Shows the spell checking setting for the drop down list.

Param out_state

Whether spell checking is enabled.

Return

true if a spell checking setting was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the drop down list.

Param out_color

The text color for the drop down list.

Return

true if a text color was specified, false otherwise.

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

Shows the text rotation for the drop down list.

Param out_rotation

The text rotation for the drop down list.

Return

true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the drop down list.

Param out_tooltip

The tooltip text for the drop down list.

Return

true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the drop down list.

Param out_state

The visibility for the drop down list.

Return

true if a visibility was specified, false otherwise.

HPS.Publish.DropDownListKit UnsetBorder ()

Removes the border setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetBorderColor ()

Removes the border color setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetBorderStyle ()

Removes the border style setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetBorderThickness ()

Removes the border thickness setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetContents ()

Removes the content setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetCustomText ()

Removes the custom text setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetEverything ()

Removes all data from the drop down list.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetFillColor ()

Removes the fill color setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetFont ()

Removes the font setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetFontSize ()

Removes the font size setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetImmediateCommit ()

Removes the immediate commit setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetLock ()

Removes the lock setting.

Return

A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetName ()

Removes the name setting.

Return

A reference to this DropDownListKit.