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

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

Underlined: Underlined (kA3DPDFUnderlined)

enum Thickness

Enumerates the thicknesses for borders.

Values:

Thin: Thin border (kA3DPDFThin)

Medium: Medium border (kA3DPDFMedium)

Wide: Wide border (kA3DPDFThick)

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

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.

HPS.Publish.DropDownListKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetSpellChecking ()

Removes the spell checking setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this DropDownListKit.

Public Static Functions

HPS.Publish.DropDownListKit GetDefault ()

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

Return: A DropDownListKit with the default settings.

bool operator!= (HPS.Publish.DropDownListKit a, HPS.Publish.DropDownListKit b)

bool operator== (HPS.Publish.DropDownListKit a, HPS.Publish.DropDownListKit b)

class ExportOptionsKit : public HPS.SprocketKit 

The ExportOptionsKit class is a user space object. It contains settings controlling how 3D PDF data is exported via Publish.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportOptionsKit has any values set on it.

Return: true if no values are set on this ExportOptionsKit, false otherwise.

bool Equals (HPS.Publish.ExportOptionsKit in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Param in_kit: The source ExportOptionsKit to compare to this ExportOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportOptionsKit (): The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit (HPS.Publish.ExportOptionsKit in_kit)

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

Param in_kit: The source ExportOptionsKit to copy.

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.ExportOptionsKit in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Param in_kit: The source ExportOptionsKit to copy.

HPS.Publish.ExportOptionsKit SetDocumentToAppendTo (string in_filename)

Sets the PDF document to append to.

Param in_filename: UTF8-encoded filename of the PDF document to append to.
Return: A reference to this ExportOptionsKit.

void Show (out HPS.Publish.ExportOptionsKit out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Param out_kit: The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

bool ShowDocumentToAppendTo (out string out_filename)

Shows the PDF document to append to setting.

Param out_filename: Filename of the PDF document to append to.
Return: true if a PDF document to append to setting was specified, false otherwise.

HPS.Publish.ExportOptionsKit UnsetDocumentToAppendTo ()

Removes the PDF document to append to setting.

Return: A reference to this ExportOptionsKit.

HPS.Publish.ExportOptionsKit UnsetEverything ()

Removes all data from the options kit.

Return: A reference to this ExportOptionsKit.

Public Static Functions

bool operator!= (HPS.Publish.ExportOptionsKit a, HPS.Publish.ExportOptionsKit b)

bool operator== (HPS.Publish.ExportOptionsKit a, HPS.Publish.ExportOptionsKit b)

class Field : public IDisposable 

The Publish.Field class is a concept class for field-related enumerations.

Public Functions

void Dispose ()

Field (HPS.Publish.Field in_that)

class File : public IDisposable 

The File class provides functions to export Model objects to 3D PDFs via Publish.

Public Functions

void Dispose ()

File (HPS.Publish.File in_that)

Public Static Functions

HPS.Publish.DocumentKey CreateDocument ()

Creates a DocumentKey based on the given PDF file. The returned object will allow direct interaction with the underlying in-memory copy of that PDF document and any pages in it. If no filename is specified, an empty PDF document will be created. The in-memory PDF document can be written to disk via the File.Export function.

Return: A DocumentKey handle for the in-memory PDF document.

HPS.Publish.DocumentKey CreateDocument (string in_file_name)

Creates a DocumentKey based on the given PDF file. The returned object will allow direct interaction with the underlying in-memory copy of that PDF document and any pages in it. If no filename is specified, an empty PDF document will be created. The in-memory PDF document can be written to disk via the File.Export function.

Param in_file_name: The name of the PDF file from which to create an in-memory copy. Defaults to nullptr, which results in an empty in-memory PDF document.
Return: A DocumentKey handle for the in-memory PDF document.

void ExportHTML (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_key_paths, string in_file_name, string in_template_name, bool in_include_measurement_information)

Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_cad_model: The CADModel containing the data to export.
Param in_additional_key_paths: An array of KeyPaths for which PRC data will be created and which will be added to in_cad_model during export. Use this parameter to specify non-Exchange data you have added to the scene which you want to export.
Param in_file_name: The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_template_name: The name of HTML template to use during export.
Param in_include_measurement_information: Whether to retain information which will allow accurate measurements to be performed on the HTML data if the input CADModel was imported with BRep data.

void ExportHTML (HPS.CADModel in_cad_model, string in_file_name, string in_template_name, bool in_include_measurement_information)

Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename.

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_cad_model: The CADModel containing the data to export.
Param in_file_name: The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_template_name: The name of HTML template to use during export.
Param in_include_measurement_information: Whether to retain information which will allow accurate measurements to be performed on the HTML data if the input CADModel was imported with BRep data.

void ExportHTML (HPS.KeyPath in_key_path, string in_file_name, string in_template_name)

Performs a synchronous Publish export of the given KeyPath with the provided options to a given filename.

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_key_path: The KeyPath containing the data to export.
Param in_file_name: The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_template_name: The name of HTML template to use during export.

void ExportHTML (HPS.KeyPath[] in_key_paths, string in_file_name, string in_template_name)

Performs a synchronous Publish export of the given KeyPathArray with the provided options to a given filename.

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_key_paths: The KeyPaths containing the data to export.
Param in_file_name: The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_template_name: The name of HTML template to use during export.

void ExportPDF (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_key_paths, string in_file_name, HPS.Publish.ExportOptionsKit in_options)

Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename. This will create a single page PDF document with a single 3D annotation. An exception will be thrown if a problem is encountered during export.

Param in_cad_model: The CADModel containing the data to export.
Param in_additional_key_paths: An array of KeyPaths for which PRC data will be created and which will be added to in_cad_model during export. Use this parameter to specify non-Exchange data you have added to the scene which you want to export.
Param in_file_name: The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_options: The options controlling the export of the 3D PDF data.

void ExportPDF (HPS.CADModel in_cad_model, string in_file_name, HPS.Publish.ExportOptionsKit in_options)

Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename. This will create a single page PDF document with a single 3D annotation. An exception will be thrown if a problem is encountered during export.

Param in_cad_model: The CADModel containing the data to export.
Param in_file_name: The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_options: The options controlling the export of the 3D PDF data.

void ExportPDF (HPS.KeyPath in_key_path, string in_file_name, HPS.Publish.ExportOptionsKit in_options)

Performs a synchronous Publish export of the given KeyPath with the provided options to a given filename. This will create a single page PDF document with a single 3D annotation. An exception will be thrown if a problem is encountered during export.

Param in_key_path: The KeyPath containing the data to export.
Param in_file_name: The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_options: The options controlling the export of the 3D PDF data.

void ExportPDF (HPS.KeyPath[] in_key_paths, string in_file_name, HPS.Publish.ExportOptionsKit in_options)

Performs a synchronous Publish export of the given KeyPathArray with the provided options to a given filename. This will create a single page PDF document with a single 3D annotation. An exception will be thrown if a problem is encountered during export.

Param in_key_paths: The KeyPaths containing the data to export.
Param in_file_name: The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_options: The options controlling the export of the 3D PDF data.

void ExportPDF (HPS.Publish.AnnotationKit in_annotation, string in_file_name, HPS.Publish.ExportOptionsKit in_options)

Performs a synchronous Publish export of the given AnnotationKit with the provided options to a given filename. This will create a single page PDF document with a single 3D annotation. An exception will be thrown if a problem is encountered during export.

Param in_annotation: The AnnotationKit containing the data to export. If the Model in the source SprocketPath for the AnnotationKit corresponds to a CADModel which was imported via Exchange, the underlying Exchange data for the CADModel will be embedded in the PDF, otherwise, the 3D data will be generated from the tessellation in the Visualize scene graph for the Model.
Param in_file_name: The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_options: The options controlling the export of the 3D PDF data.

void ExportPDF (HPS.Publish.DocumentKey in_document, string in_file_name)

Performs a synchronous Publish export of the given DocumentKey to a given filename. This will not close the PDF document underlying the DocumentKey, rather it will just create a copy of it on disk. The DocumentKey can still be used after this call to interact with the in-memory PDF document.

Param in_document: The DocumentKey from which to create a PDF file on disk.
Param in_file_name: The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.

void ExportPDF (HPS.Publish.DocumentKit in_document, string in_file_name, HPS.Publish.ExportOptionsKit in_options)

Performs a synchronous Publish export of the given DocumentKit with the provided options to a given filename. This will create a PDF document based on the DocumentKit. An exception will be thrown if a problem is encountered during export.

Param in_document: The DocumentKit containing the data to export. If any Model in the source SprocketPath for any AnnotationKit in the DocumentKit corresponds to a CADModel which was imported via Exchange, the underlying Exchange data for the CADModel will be embedded in the PDF, otherwise, the 3D data will be generated from the tessellation in the Visualize scene graph for the Model.
Param in_file_name: The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.
Param in_options: The options controlling the export of the 3D PDF data.

class Highlighting : public IDisposable 

The Publish.Highlighting class is a concept class for highlighting-related enumerations.

Public Types

enum Mode

Enumerates the highlighting modes for LinkKit objects.

Values:

None: No highlighting (kA3DPDFLinkHighlightNone)

Invert: Invert the colors in the content area (kA3DPDFLinkHighlightInvert)

Outline: Invert the color of the outline of the content area (kA3DPDFLinkHighlightOutline)

Push: Content area will appear to depress into the page (kA3DPDFLinkHighlightPush)

Public Functions

void Dispose ()

Highlighting (HPS.Publish.Highlighting in_that)

class Image : public IDisposable 

The Publish.Image class is a concept class for image-related enumerations.

Public Types

enum Format

Enumerates the image formats that Publish can insert into a PDF.

Values:

Unknown: Unknown format (kA3DPDFImageFormatUnknown).

BMP: Bitmap format (kA3DPDFImageFormatBmp).

PNG: PNG format (kA3DPDFImageFormatPng).

JPEG: JPEG format (kA3DPDFImageFormatJpg).

RawRGB: RGB format, 3 bytes per pixel (kA3DPDFImageFormatBitmapRgbByte).

RawRGBA: RGBA format, 4 bytes per pixel (kA3DPDFImageFormatBitmapRgbaByte).

RawGrey: Greyscale format, 1 byte per pixel (kA3DPDFImageFormatBitmapGreyByte).

RawGreyA: Greyscale + alpha format, 2 bytes per pixel (kA3DPDFImageFormatBitmapGreyaByte).

EMF: EMF format (kA3DPDFImageFormatEmf).

URL: URL format (kA3DPDFImageFormatUrl).

GIF: GIF format (kA3DPDFImageFormatGif).

TIFF: TIFF format (kA3DPDFImageFormatTif).

PCX: PCX format (kA3DPDFImageFormatPcx).

Targa: Targa format (kA3DPDFImageFormatTga).

PPM: PPM format (kA3DPDFImageFormatPpm).

ILBM: ILBM format (kA3DPDFImageFormatIlbm).

CEL: Cel format (kA3DPDFImageFormatCel).

RGB: RGB format (kA3DPDFImageFormatRgb).

PSD: Photoshop PSD format (kA3DPDFImageFormatPsd).

PIC: Softimage PIC format (kA3DPDFImageFormatSoftimagepic).

Public Functions

void Dispose ()

Image (HPS.Publish.Image in_that)

class ImageKit : public HPS.SprocketKit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ImageKit has any values set on it.

Return: true if no values are set on this ImageKit, false otherwise.

bool Equals (HPS.Publish.ImageKit in_kit)

Check if the source ImageKit is equivalent to this ImageKit.

Param in_kit: The source ImageKit to compare to this ImageKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ImageKit (): The default constructor creates an empty ImageKit object.

ImageKit (HPS.Publish.ImageKit in_kit)

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

Param in_kit: The source ImageKit to copy.

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.ImageKit in_kit)

Copies the source ImageKit into this ImageKit.

Param in_kit: The source ImageKit to copy.

HPS.Publish.ImageKit SetFile (string in_filename)

Sets the file for the image. This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName.

Param in_filename: UTF8-encoded filename for the image.
Return: A reference to this ImageKit.

HPS.Publish.ImageKit SetFormat (HPS.Publish.Image.Format in_format)

Sets the format of the image. This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat.

Param in_format: The format of the image.
Return: A reference to this ImageKit.

HPS.Publish.ImageKit SetSize (int in_width, int in_height)

Sets the size of the image in pixels. This corresponds to the value that will be passed to A3DPDFImageData::m_iWidth and A3DPDFImageData::m_iHeight.

Param in_width: The width of the image in pixels.
Param in_height: The height of the image in pixels.
Return: A reference to this ImageKit.

void Show (out HPS.Publish.ImageKit out_kit)

Copies this ImageKit into the given ImageKit.

Param out_kit: The ImageKit to populate with the contents of this ImageKit.

bool ShowFile (out string out_filename)

Shows the file setting.

Param out_filename: The filename for the image.
Return: true if a color was specified, false otherwise.

bool ShowFormat (out HPS.Publish.Image.Format out_format)

Shows the format setting.

Param out_format: The format of the image.
Return: true if a format was specified, false otherwise.

bool ShowSize (out int out_width, out int out_height)

Shows the size setting.

Param out_width: The width of the image in pixels.
Param out_height: The height of the image in pixels.
Return: true if a width and height were specified, false otherwise.

HPS.Publish.ImageKit UnsetEverything ()

Removes all data from the image.

Return: A reference to this ImageKit.

HPS.Publish.ImageKit UnsetFile ()

Removes the file from the image.

Return: A reference to this ImageKit.

HPS.Publish.ImageKit UnsetFormat ()

Removes the format from the image.

Return: A reference to this ImageKit.

HPS.Publish.ImageKit UnsetSize ()

Removes the size from the image.

Return: A reference to this ImageKit.

Public Static Functions

bool operator!= (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b)

bool operator== (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b)

class Label : public IDisposable 

The Publish.Label class is a concept class for label-related enumerations.

Public Types

enum Position

Enumerates the label positions.

Values:

LabelOnly: Only the label will be displayed (kA3DPDFLabelOnly)

IconOnly: Only the icon will be displayed (kA3DPDFIconOnly)

Top: The label will be displayed above the icon (kA3DPDFLabelTopIconBottom)

Bottom: The label will be displayed below the icon (kA3DPDFIconTopLabelBottom)

Left: The label will be displayed to the left of the icon (kA3DPDFLabelLeftIconRight)

Right: The label will be displayed to the right of the icon (kA3DPDFIconTopLabelBottom)

OnTop: The label will be displayed on top of the icon (kA3DPDFLabelOverIcon)

Public Functions

void Dispose ()

Label (HPS.Publish.Label in_that)

class Lighting : public IDisposable 

The Publish.Lighting class is a concept class for lighting-related enumerations.

Public Types

enum Mode

/enum Mode Enumerates the lighting modes for ViewKit and AnnotationKit objects.

Values:

Artwork: Inerhit the light from the annotation (kA3DPDFLightArtworkCurrent).

None: No light (kA3DPDFLightNone).

White: White light (kA3DPDFLightWhite).

Day: Day light (kA3DPDFLightDay).

Bright: Bright light (kA3DPDFLightBright).

PrimaryColor: Primary color light (kA3DPDFLightPrimaryColor).

Night: Night light (kA3DPDFLightNight).

Blue: Blue light (kA3DPDFLightBlue).

Red: Red light (kA3DPDFLightRed).

Cube: Cube light (kA3DPDFLightCube).

CADOptimized: CAD Optimized light (kA3DPDFLightCADOptimized).

Headlamp: Headlamp light (kA3DPDFLightHeadlamp).

Public Functions

void Dispose ()

Lighting (HPS.Publish.Lighting in_that)

class LinkKit : public HPS.SprocketKit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this LinkKit has any values set on it.

Return: true if no values are set on this LinkKit, false otherwise.

bool Equals (HPS.Publish.LinkKit in_kit)

Check if the source LinkKit is equivalent to this LinkKit.

Param in_kit: The source LinkKit to compare to this LinkKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

LinkKit (): The default constructor creates an empty LinkKit object.

LinkKit (HPS.Publish.LinkKit in_kit)

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

Param in_kit: The source LinkKit to copy.

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.LinkKit in_kit)

Copies the source LinkKit into this LinkKit.

Param in_kit: The source LinkKit to copy.

HPS.Publish.LinkKit SetBorderColor (HPS.RGBColor in_color)

Sets the color of the border for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_sColor.

Param in_color: The color of the border for the link.
Return: A reference to this LinkKit.

HPS.Publish.LinkKit SetBorderWidth (int in_width)

Sets the border width in points for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_iBorderWidth.

Param in_width: The border width in points for the link.
Return: A reference to this LinkKit.

HPS.Publish.LinkKit SetHighlighting (HPS.Publish.Highlighting.Mode in_mode)

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

Param in_mode: The highlighting mode for the link.
Return: A reference to this LinkKit.

HPS.Publish.LinkKit SetJavaScript (string in_source)

Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_pcJavascriptString.

Param in_source: The JavaScript source or file (depending on the next argument) for the link.
Return: A reference to this LinkKit.

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

Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_pcJavascriptString.

Param in_source: The JavaScript source or file (depending on the next argument) for the link.
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this LinkKit.

void Show (out HPS.Publish.LinkKit out_kit)

Copies this LinkKit into the given LinkKit.

Param out_kit: The LinkKit to populate with the contents of this LinkKit.

bool ShowBorderColor (out HPS.RGBColor out_color)

Shows the border color setting.

Param out_color: The border color of the link.
Return: true if a border color was specified, false otherwise.

bool ShowBorderWidth (out int out_width)

Shows the border width setting.

Param out_width: The border width of the link.
Return: true if a border width was specified, false otherwise.

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

Shows the highlighting mode setting.

Param out_mode: The highlighting mode of the link.
Return: true if a highlighting mode 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 link.
Param out_type: The type of the preceding argument.
Return: true if a JavaScript source or file was specified, false otherwise.

HPS.Publish.LinkKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this LinkKit.

HPS.Publish.LinkKit UnsetBorderWidth ()

Removes the border width setting.

Return: A reference to this LinkKit.

HPS.Publish.LinkKit UnsetEverything ()

Removes all data from the link.

Return: A reference to this LinkKit.

HPS.Publish.LinkKit UnsetHighlighting ()

Removes the highlighting mode setting.

Return: A reference to this LinkKit.

HPS.Publish.LinkKit UnsetJavaScript ()

Removes the JavaScript setting.

Return: A reference to this LinkKit.

Public Static Functions

bool operator!= (HPS.Publish.LinkKit a, HPS.Publish.LinkKit b)

bool operator== (HPS.Publish.LinkKit a, HPS.Publish.LinkKit b)

class ListBoxKit : public HPS.SprocketKit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ListBoxKit has any values set on it.

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

bool Equals (HPS.Publish.ListBoxKit in_kit)

Check if the source ListBoxKit is equivalent to this ListBoxKit.

Param in_kit: The source ListBoxKit to compare to this ListBoxKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ListBoxKit (): The default constructor creates an empty ListBoxKit object.

ListBoxKit (HPS.Publish.ListBoxKit in_kit)

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

Param in_kit: The source ListBoxKit to copy.

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.ListBoxKit in_kit)

Copies the source ListBoxKit into this ListBoxKit.

Param in_kit: The source ListBoxKit to copy.

HPS.Publish.ListBoxKit SetBorder (bool in_state)

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

Param in_state: Whether the list box has a border.
Return: A reference to this ListBoxKit.

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

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

Param in_color: The border color of the list box.
Return: A reference to this ListBoxKit.

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

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

Param in_style: The border style for the list box.
Return: A reference to this ListBoxKit.

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

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

Param in_thickness: The border thickness for the list box.
Return: A reference to this ListBoxKit.

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

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

Param in_displayed_values: The values displayed in the list box
Param in_export_values: The export values associated with the values displayed
Return: A reference to this ListBoxKit.

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

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

Param in_color: The fill color for the list box.
Return: A reference to this ListBoxKit.

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

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

Param in_name: The builtin font for the list box.
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetFont (string in_name)

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

Param in_name: UTF8-encoded font name for the list box.
Return: A reference to this ListBoxKit.

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

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

Param in_name: UTF8-encoded font name for the list box.
Param in_style: The style of font to use for the list box.
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetFontSize (int in_size)

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

Param in_size: The font size for the list box.
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetLock (bool in_state)

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

Param in_state: Whether the list box is locked.
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetMultipleSelection (bool in_state)

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

Param in_state: Whether multiple selection is allowed
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetName (string in_name)

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

Param in_name: UTF8-encoded name of the list box.
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetPrintability (bool in_state)

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

Param in_state: The printability for the list box.
Return: A reference to this ListBoxKit.

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

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

Param in_color: The text color for the list box.
Return: A reference to this ListBoxKit.

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

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

Param in_rotation: The text rotation for the list box.
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetTooltip (string in_tooltip)

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

Param in_tooltip: UTF8-encoded tooltip text for the list box.
Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit SetVisibility (bool in_state)

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

Param in_state: The visibility for the list box.
Return: A reference to this ListBoxKit.

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

Copies this ListBoxKit into the given ListBoxKit.

Param out_kit: The ListBoxKit to populate with the contents of this ListBoxKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the list box.

Param out_state: Whether the list 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 list box.

Param out_color: The border color of the list 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 list box.

Param out_style: The border style for the list 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 list box.

Param out_thickness: The border thickness for the list box.
Return: true if a border thickness was specified, false otherwise.

bool ShowContents (out string[] out_displayed_values, out string[] out_export_values)

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the list box.

Param out_color: The fill color for the list 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 list box.

Param out_type: The type of font for the list box.
Param out_font: The built-in font for the list box. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the list box. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_style: The font style for the list 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 list box.

Param out_size: The font size for the list box.
Return: true if a font size was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the list box.

Return: true if a lock setting was specified, false otherwise.

bool ShowMultipleSelection (out bool out_state)

Shows the multiple selection setting for the list box.

Param out_state: Whether multiple selection is enabled.
Return: true if a multiple selection setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the list box.

Param out_name: The name of the list box.
Return: true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the list box.

Param out_state: The printability for the list box.
Return: true if a printability was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the list box.

Param out_color: The text color for the list 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 list box.

Param out_rotation: The text rotation for the list box.
Return: true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the list box.

Param out_tooltip: The tooltip text for the list box.
Return: true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the list box.

Param out_state: The visibility for the list box.
Return: true if a visibility was specified, false otherwise.

HPS.Publish.ListBoxKit UnsetBorder ()

Removes the border setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetContents ()

Removes the content setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetEverything ()

Removes all data from the list box.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetFont ()

Removes the font setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetLock ()

Removes the lock setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetMultipleSelection ()

Removes the multiple selection setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetName ()

Removes the name setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this ListBoxKit.

HPS.Publish.ListBoxKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this ListBoxKit.

Public Static Functions

HPS.Publish.ListBoxKit GetDefault ()

Creates a ListBoxKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a button unless a setting is overridden by the ListBoxKit passed to a function.

Return: A ListBoxKit with the default settings.

bool operator!= (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit b)

bool operator== (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit b)

class Page : public IDisposable 

The Publish.Page class is a concept class for page-related enums.

Public Types

enum Format

Enumerates the page formats to use when generating a PDF via Publish.

Values:

P11x17: Standard 11” x 17” format, 792 x 1124 points (kA3DPDFPage11x17).

A3: Standard A3 format, 842 x 1190 points (kA3DPDFPageA3).

A4: Standard A4 format, 595 x 842 points (kA3DPDFPageA4).

A5: Standard A5 format, 420 x 595 points (kA3DPDFPageA5).

B4JIS: Standard B4 JIS format, 728 x 1031 points (kA3DPDFPageB4JIS).

B5JIS: Standard B5 JIS format, 515 x 728 points (kA3DPDFPageB5JIS).

Executive: Standard Executive format, 522 x 756 points (kA3DPDFPageExecutive).

Legal: Standard Legal format, 612 x 1008 points (kA3DPDFPageLegal).

Letter: Standard Letter format, 612 x 792 points (kA3DPDFPageLetter).

Tabloid: Standard Tabloid format, 792 x 1224 points (kA3DPDFPageTabloid).

B4ISO: Standard B4 ISO format, 709 x 1001 points (kA3DPDFPageB4ISO).

B5ISO: Standard B5 ISO format, 499 x 709 points (kA3DPDFPageB5ISO).

enum Orientation

Enumerates the page orientations to use when generating a PDF via Publish.

Values:

Portrait: Self-explanatory (kA3DPDFPagePortrait).

Landscape: Self-explanatory (kA3DPDFPageLandscape).

Public Functions

void Dispose ()

Page (HPS.Publish.Page in_that)

class PageControl : public HPS.Sprocket 

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

Public Functions

HPS.Publish.PageControl AddAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle in_location)

Adds an annotation to the page. This will not replace any existing annotations on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.

Param in_annotation: Annotation to add to the page.
Param in_location: Annotation location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations)

Adds a list of annotations to the page. This will not replace any existing annotations on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.

Param in_annotations: Annotations to add to the page.
Param in_locations: Annotation locations in points relative to bottom left of the page.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location)

Adds a button to the page. This will not replace any buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.

Param in_button: Button to add to the page.
Param in_location: Button location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations)

Adds a list of buttons to the page. This will not replace any buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.

Param in_buttons: Buttons to add to the page.
Param in_locations: Button locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddCheckBox (HPS.Publish.CheckBoxKit in_check_box, HPS.IntRectangle in_location)

Adds a check box to the page. This will not replace any check boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.

Param in_check_box: Check box to add to the page.
Param in_location: Check box location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddCheckBoxes (HPS.Publish.CheckBoxKit[] in_check_boxes, HPS.IntRectangle[] in_locations)

Adds a list of check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.

Param in_check_boxes: Check boxes to add to the page.
Param in_locations: Check box locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location)

Adds a drop down list to the page. This will not replace any drop down lists on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.

Param in_drop_down_list: Drop down list to add to the page.
Param in_location: Drop down list location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_lists, HPS.IntRectangle[] in_locations)

Adds a list of drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.

Param in_drop_down_lists: Drop down lists to add to the page.
Param in_locations: Drop down list locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location)

Adds an image to the page. This will not replace any images on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.

Param in_image: Image to add to the page.
Param in_location: Image location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations)

Adds a list of images to the page. This will not replace any images on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.

Param in_images: Images to add to the page.
Param in_locations: Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location)

Adds a link to the page. This will not replace any links on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.

Param in_link: Link to add to the page.
Param in_location: Link location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations)

Adds a list of links to the page. This will not replace any links on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.

Param in_links: Links to add to the page.
Param in_locations: Link locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location)

Adds a list box to the page. This will not replace any list boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.

Param in_list_box: List box to add to the page.
Param in_location: List box location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddListBoxes (HPS.Publish.ListBoxKit[] in_list_boxes, HPS.IntRectangle[] in_locations)

Adds a list of list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.

Param in_list_boxes: List boxes to add to the page.
Param in_locations: List box locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddListItemByField (string in_field, string in_value, string in_export_value)

Adds an item to the list at the given form field. The item to will be appended to any existing items in the list at the given form field. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the list.
Param in_value: UTF8-encoded value for the item to be added to the list at the given form field.
Param in_export_value: UTF8-encoded export value for the item to be added to the list at the given form field.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddListItemsByField (string in_field, string[] in_values, string[] in_export_values)

Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the list.
Param in_values: The values for the items to be added to the list at the given form field.
Param in_export_values: The export values for the items to be added to the list at the given form field.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location)

Adds a radio button to the page. This will not replace any radio buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.

Param in_radio_button: Radio button to add to the page.
Param in_location: Radio button location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations)

Adds a list of radio buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.

Param in_radio_buttons: Radio buttons to add to the page.
Param in_locations: Radio button locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location)

Adds a signature field to the page. This will not replace any signature fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.

Param in_signature_field: Signature field to add to the page.
Param in_location: Signature field location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_fields, HPS.IntRectangle[] in_locations)

Adds a list of signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.

Param in_signature_fields: Signature fields to add to the page.
Param in_locations: Signature field locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location)

Adds a slide table to the page. This will not replace any slide tables on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Param in_slide_table: Slide table to add to the page.
Param in_location: Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations)

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Param in_slide_tables: Slide tables to add to the page.
Param in_locations: Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location)

Adds a table to the page. This will not replace any tables on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Param in_table: Table to add to the page.
Param in_location: Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations)

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Param in_tables: Tables to add to the page.
Param in_locations: Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location)

Adds a text string to the page. This will not replace any text on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.

Param in_text: Text to add to the page.
Param in_location: Text location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations)

Adds text strings to the page. This will not replace any text on the page. These correspond to values that will be passed to A3DPDFPageInsertText.

Param in_text: Text to add to the page.
Param in_locations: Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location)

Adds a text field to the page. This will not replace any text fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.

Param in_text_field: Text field to add to the page.
Param in_location: Text field location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageControl.

HPS.Publish.PageControl AddTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations)

Adds a list of text fields to the page. This will not replace any text fields on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.

Param in_text_fields: Text fields to add to the page.
Param in_locations: Text field locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageControl.

override void Dispose ()

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.

PageControl (): The default constructor creates an uninitialized PageControl object. The Type() function will return Type.None.

PageControl (HPS.Publish.PageControl in_that)

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

Param in_that: The source PageControl to copy.

HPS.Publish.PageControl SetAnnotationByField (string in_field, HPS.Publish.AnnotationKit in_annotation)

Sets an annotation on the given form field. If there is an existing annotation on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the annotation.
Param in_annotation: The annotation to be set on the given form field.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetAnnotationsByField (string[] in_fields, HPS.Publish.AnnotationKit[] in_annotations)

Sets annotations on the given form fields. If there is an existing annotation on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_fields: The form field names for the annotations.
Param in_annotations: The annotations to be set on the corresponding form fields.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetButtonIconByField (string in_field, HPS.Publish.ImageKit in_image)

Sets an image on the icon at the given form field. If there is an existing image on an icon at the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the icon.
Param in_image: The image to be set on the icon at the given form field.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetButtonIconsByField (string[] in_fields, HPS.Publish.ImageKit[] in_images)

Sets images on the icons at the given form fields. If there is an existing image on an icon at a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_fields: The form field names for the icons.
Param in_images: The images to be set on the icons at the corresponding form fields.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetButtonLabelByField (string in_field, string in_label)

Sets a label on the given form field. If there is an existing label on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the label.
Param in_label: UTF8-encoded label to be set on the given form field.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetButtonLabelsByField (string[] in_fields, string[] in_labels)

Sets labels on the given form fields. If there is an existing label on a given form field, it will get overwritten. These correspond to the values that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_fields: The form field names for the labels.
Param in_labels: The labels to be set on the corresponding form fields.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetJavaScriptActionByField (string in_field, string in_source)

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the JavaScript action.
Param in_source: UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetJavaScriptActionByField (string in_field, string in_source, HPS.Publish.Source.Type in_type)

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the JavaScript action.
Param in_source: UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetJavaScriptActionsByField (string[] in_fields, string[] in_sources, HPS.Publish.Source.Type[] in_types)

Sets JavaScript sources and/or files on the given form fields. If there is any existing JavaScript source or file at a given form field, it will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_fields: The form field names for the JavaScript actions.
Param in_sources: The JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
Param in_types: The types for each item in the preceding argument array.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetTextValueByField (string in_field, string in_value)

Sets a text value on the given form field. If there is an existing text value on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name for the text value.
Param in_value: UTF8-encoded text value to be set on the given form field.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetTextValuesByField (string[] in_fields, string[] in_values)

Sets text values on the given form fields. If there is an existing text value on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_fields: The form field names for the text values.
Param in_values: The text values to be set on the corresponding form fields.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetVisibilitiesByField (string[] in_fields, bool[] in_states)

Sets whether the objects at the given form fields should be visible. If there is an existing visibility on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_fields: The form field names on which to set visibility.
Param in_states: Whether the objects at the at the corresponding form fields should be visible.
Return: A reference to this PageControl.

HPS.Publish.PageControl SetVisibilityByField (string in_field, bool in_state)

Sets whether the object at the given form field should be visible. If there is an existing visibility on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Param in_field: UTF8-encoded form field name on which to set visibility.
Param in_state: Whether the object at the at the given form field should be visible.
Return: A reference to this PageControl.

bool ShowFields (out string[] out_names, out HPS.IntRectangle[] out_locations, out HPS.Publish.Field.Type[] out_types)

class PageKit : public HPS.SprocketKit 

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

Public Functions

HPS.Publish.PageKit AddAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle in_location)

Adds an annotation to the page. This will not replace any existing annotations on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.

Param in_annotation: Annotation to add to the page.
Param in_location: Annotation location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations)

Adds a list of annotations to the page. This will not replace any existing annotations on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.

Param in_annotations: Annotations to add to the page.
Param in_locations: Annotation locations in points relative to bottom left of the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location)

Adds a button to the page. This will not replace any buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.

Param in_button: Button to add to the page.
Param in_location: Button location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations)

Adds a list of buttons to the page. This will not replace any buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.

Param in_buttons: Buttons to add to the page.
Param in_locations: Button locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddCheckBox (HPS.Publish.CheckBoxKit in_checkbox, HPS.IntRectangle in_location)

Adds a check box to the page. This will not replace any check boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.

Param in_checkbox: Check Box to add to the page.
Param in_location: Check Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddCheckBoxes (HPS.Publish.CheckBoxKit[] in_checkbox, HPS.IntRectangle[] in_locations)

Adds check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.

Param in_checkbox: Check Box to add to the page.
Param in_locations: Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location)

Adds a drop down list to the page. This will not replace any drop down lists on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.

Param in_drop_down_list: Drop Down List to add to the page.
Param in_location: Drop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_list, HPS.IntRectangle[] in_locations)

Adds drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.

Param in_drop_down_list: Drop Down List to add to the page.
Param in_locations: Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location)

Adds an image to the page. This will not replace any images on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.

Param in_image: Image to add to the page.
Param in_location: Image location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations)

Adds a list of images to the page. This will not replace any images on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.

Param in_images: Images to add to the page.
Param in_locations: Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location)

Adds a link to the page. This will not replace any links on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.

Param in_link: Link to add to the page.
Param in_location: Link location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations)

Adds a list of links to the page. This will not replace any links on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.

Param in_links: Links to add to the page.
Param in_locations: Link locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location)

Adds a list box to the page. This will not replace any list boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.

Param in_list_box: List Box to add to the page.
Param in_location: List Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddListBoxes (HPS.Publish.ListBoxKit[] in_list_box, HPS.IntRectangle[] in_locations)

Adds list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.

Param in_list_box: List Box to add to the page.
Param in_locations: List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddListItemByField (string in_field, string in_value, string in_export_value)

Adds an item to the list at the given form field. The item to will be appended to any existing items in the list at the given form field. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the list.
Param in_value: UTF8-encoded value for the item to be added to the list at the given form field.
Param in_export_value: UTF8-encoded export value for the item to be added to the list at the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddListItemsByField (string in_field, string[] in_values, string[] in_export_values)

Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the list.
Param in_values: The values for the items to be added to the list at the given form field.
Param in_export_values: The export values for the items to be added to the list at the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location)

Adds a radio button to the page. This will not replace any radio buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.

Param in_radio_button: Radio button to add to the page.
Param in_location: Button location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations)

Adds a list of buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.

Param in_radio_buttons: Radio buttons to add to the page.
Param in_locations: Button locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location)

Adds a signature field to the page. This will not replace any signature fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.

Param in_signature_field: Signature Field to add to the page.
Param in_location: Signature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_field, HPS.IntRectangle[] in_locations)

Adds signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.

Param in_signature_field: Signature Field to add to the page.
Param in_locations: Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location)

Adds a slide table to the page. This will not replace any slide tables on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Param in_slide_table: Slide table to add to the page.
Param in_location: Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations)

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Param in_slide_tables: Slide tables to add to the page.
Param in_locations: Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location)

Adds a table to the page. This will not replace any tables on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Param in_table: Table to add to the page.
Param in_location: Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations)

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Param in_tables: Tables to add to the page.
Param in_locations: Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location)

Adds a text string to the page. This will not replace any text on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.

Param in_text: Text to add to the page.
Param in_location: Text location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations)

Adds text strings to the page. This will not replace any text on the page. These correspond to values that will be passed to A3DPDFPageInsertText.

Param in_text: Text to add to the page.
Param in_locations: Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location)

Adds a text field to the page. This will not replace any text fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.

Param in_text_field: Text field to add to the page.
Param in_location: Text field location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit AddTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations)

Adds a list of text fields to the page. This will not replace any text fields on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.

Param in_text_fields: Text fields to add to the page.
Param in_locations: Text field locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

override void Dispose ()

override bool Empty ()

Indicates whether this PageKit has any values set on it.

Return: true if no values are set on this PageKit, false otherwise.

bool Equals (HPS.Publish.PageKit in_kit)

Check if the source PageKit is equivalent to this PageKit.

Param in_kit: The source PageKit to compare to this PageKit.
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.

PageKit (): The default constructor creates an empty PageKit object.

PageKit (HPS.Publish.Page.Format in_format, HPS.Publish.Page.Orientation in_orientation)

This constructor creates a PageKit with the given format and orientation.

Param in_format: Format of the page.
Param in_orientation: Orientation of the page.

PageKit (HPS.Publish.PageKit in_kit)

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

Param in_kit: The source PageKit to copy.

PageKit (string in_filename)

This constructor creates a PageKit from the given PDF template file.

Param in_filename: UTF8-encoded filename for the PDF file to act as a template.

void Set (HPS.Publish.PageKit in_kit)

Copies the source PageKit into this PageKit.

Param in_kit: The source PageKit to copy.

HPS.Publish.PageKit SetAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle in_location)

Adds an annotation to the page. This will replace all annotations (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.

Param in_annotation: Annotation to add to the page.
Param in_location: Annotation location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetAnnotationByField (string in_field, HPS.Publish.AnnotationKit in_annotation)

Sets an annotation on the given form field. If there is an existing annotation on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the annotation.
Param in_annotation: The annotation to be set on the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations)

Adds a list of annotations to the page. This will replace all annotations (if any) on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.

Param in_annotations: Annotations to add to the page.
Param in_locations: Annotation locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetAnnotationsByField (string[] in_fields, HPS.Publish.AnnotationKit[] in_annotations)

Sets annotations on the given form fields. If there is an existing annotation on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the page has a template file.

Param in_fields: The form field names for the annotations.
Param in_annotations: The annotations to be set on the corresponding form fields.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location)

Adds a button to the page. This will replace all buttons (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.

Param in_button: Button to add to the page.
Param in_location: Button location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetButtonIconByField (string in_field, HPS.Publish.ImageKit in_image)

Sets an image on the icon at the given form field. If there is an existing image on an icon at the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the icon.
Param in_image: The image to be set on the icon at the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetButtonIconsByField (string[] in_fields, HPS.Publish.ImageKit[] in_images)

Sets images on the icons at the given form fields. If there is an existing image on an icon at a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the page has a template file.

Param in_fields: The form field names for the icons.
Param in_images: The images to be set on the icons at the corresponding form fields.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetButtonLabelByField (string in_field, string in_label)

Sets a label on the given form field. If there is an existing label on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the label.
Param in_label: UTF8-encoded label to be set on the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetButtonLabelsByField (string[] in_fields, string[] in_labels)

Sets labels on the given form fields. If there is an existing label on a given form field, it will get overwritten. These correspond to the values that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the page has a template file.

Param in_fields: The form field names for the labels.
Param in_labels: The labels to be set on the corresponding form fields.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations)

Adds a list of buttons to the page. This will replace all buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.

Param in_buttons: Buttons to add to the page.
Param in_locations: Button locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetCheckBox (HPS.Publish.CheckBoxKit in_checkbox, HPS.IntRectangle in_location)

Adds a check box to the page. This will replace all check box (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.

Param in_checkbox: Check Box to add to the page.
Param in_location: Check Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetCheckBoxes (HPS.Publish.CheckBoxKit[] in_checkbox, HPS.IntRectangle[] in_locations)

Adds check boxes to the page. This will replace all check boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.

Param in_checkbox: Check Box to add to the page.
Param in_locations: Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location)

Adds a drop down list to the page. This will replace all drop down list (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.

Param in_drop_down_list: Drop Down List to add to the page.
Param in_location: Drop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_list, HPS.IntRectangle[] in_locations)

Adds drop down lists to the page. This will replace all drop down lists (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.

Param in_drop_down_list: Drop Down List to add to the page.
Param in_locations: Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetFormat (HPS.Publish.Page.Format in_format)

Sets the format of the page. This corresponds to the value that will be passed to A3DPDFPageData::m_ePageSize. This has no effect if this page has a template file.

Param in_format: Format of the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location)

Adds an image to the page. This will replace all images (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.

Param in_image: Image to add to the page.
Param in_location: Image location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations)

Adds a list of images to the page. This will replace all images (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.

Param in_images: Images to add to the page.
Param in_locations: Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetJavaScriptActionByField (string in_field, string in_source)

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the JavaScript action.
Param in_source: UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetJavaScriptActionByField (string in_field, string in_source, HPS.Publish.Source.Type in_type)

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the JavaScript action.
Param in_source: UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetJavaScriptActionsByField (string[] in_fields, string[] in_sources, HPS.Publish.Source.Type[] in_types)

Sets JavaScript sources and/or files on the given form fields. If there is any existing JavaScript source or file at a given form field, it will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the page has a template file.

Param in_fields: The form field names for the JavaScript actions.
Param in_sources: The JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
Param in_types: The types for each item in the preceding argument array.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location)

Adds a link to the page. This will replace all links (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.

Param in_link: Link to add to the page.
Param in_location: Link location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations)

Adds a list of links to the page. This will replace all links (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.

Param in_links: Links to add to the page.
Param in_locations: Link locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location)

Adds a list box to the page. This will replace all list box (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.

Param in_list_box: List Box to add to the page.
Param in_location: List Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetListBoxes (HPS.Publish.ListBoxKit[] in_list_box, HPS.IntRectangle[] in_locations)

Adds list boxes to the page. This will replace all list boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.

Param in_list_box: List Box to add to the page.
Param in_locations: List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetListItemByField (string in_field, string in_value, string in_export_value)

Adds an item to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the list.
Param in_value: UTF8-encoded value for the item to be added to the list at the given form field.
Param in_export_value: UTF8-encoded export value for the item to be added to the list at the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetListItemsByField (string in_field, string[] in_values, string[] in_export_values)

Adds items to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the list.
Param in_values: The values for the items to be added to the list at the given form field.
Param in_export_values: The export values for the items to be added to the list at the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetOrientation (HPS.Publish.Page.Orientation in_orientation)

Sets the orientation of the page. This corresponds to the value that will be passed to A3DPDFPageData::m_ePageOrientation. This has no effect if this page has a template file.

Param in_orientation: Orientation of the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location)

Adds a radio button to the page. This will replace all radio buttons (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.

Param in_radio_button: Radio button to add to the page.
Param in_location: Button location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations)

Adds a list of buttons to the page. This will replace all radio buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.

Param in_radio_buttons: Radio buttons to add to the page.
Param in_locations: Button locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location)

Adds a signature field to the page. This will replace all signature field (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.

Param in_signature_field: Signature Field to add to the page.
Param in_location: Signature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_field, HPS.IntRectangle[] in_locations)

Adds signature fields to the page. This will replace all signature fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.

Param in_signature_field: Signature Field to add to the page.
Param in_locations: Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location)

Adds a slide table to the page. This will replace all slide tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Param in_slide_table: Slide table to add to the page.
Param in_location: Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations)

Adds a list of slide tables to the page. This will replace all slide tables (if any) on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Param in_slide_tables: Slide tables to add to the page.
Param in_locations: Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location)

Adds a table to the page. This will replace all tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Param in_table: Table to add to the page.
Param in_location: Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations)

Adds a list of tables to the page. This will replace all tables (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Param in_tables: Tables to add to the page.
Param in_locations: Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetTemplateFile (string in_filename)

Sets the PDF file which will act as a template.

Param in_filename: UTF8-encoded filename for the PDF file to act as a template.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location)

Adds a text string to the page. This will replace all text (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.

Param in_text: Text to add to the page.
Param in_location: Text location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations)

Adds text strings to the page. This will replace all text (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertText.

Param in_text: Text to add to the page.
Param in_locations: Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location)

Adds a text field to the page. This will replace all text fields (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.

Param in_text_field: Text field to add to the page.
Param in_location: Text field location in points relative to bottom left of the page. All fields in the location will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations)

Adds a list of text fields to the page. This will replace all text fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.

Param in_text_fields: Text fields to add to the page.
Param in_locations: Text field locations in points relative to bottom left of the page. All fields in the locations will be used.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetTextValueByField (string in_field, string in_value)

Sets a text value on the given form field. If there is an existing text value on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name for the text value.
Param in_value: UTF8-encoded text value to be set on the given form field.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetTextValuesByField (string[] in_fields, string[] in_values)

Sets text values on the given form fields. If there is an existing text value on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the page has a template file.

Param in_fields: The form field names for the text values.
Param in_values: The text values to be set on the corresponding form fields.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetVisibilitiesByField (string[] in_fields, bool[] in_states)

Sets whether the objects at the given form fields should be visible. If there is an existing visibility on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the page has a template file.

Param in_fields: The form field names on which to set visibility.
Param in_states: Whether the objects at the at the corresponding form fields should be visible.
Return: A reference to this PageKit.

HPS.Publish.PageKit SetVisibilityByField (string in_field, bool in_state)

Sets whether the object at the given form field should be visible. If there is an existing visibility on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the page has a template file.

Param in_field: UTF8-encoded form field name on which to set visibility.
Param in_state: Whether the object at the at the given form field should be visible.
Return: A reference to this PageKit.

void Show (out HPS.Publish.PageKit out_kit)

Copies this PageKit into the given PageKit.

Param out_kit: The PageKit to populate with the contents of this PageKit.

bool ShowAnnotations (out HPS.Publish.AnnotationKit[] out_annotations, out HPS.IntRectangle[] out_locations)

Shows the annotations on the page.

Param out_annotations: Annotations on the page.
Param out_locations: Annotation locations on the page.
Return: true if annotations were specified, false otherwise.

bool ShowAnnotationsByField (out string[] out_fields, out HPS.Publish.AnnotationKit[] out_annotations)

bool ShowButtonIconsByField (out string[] out_fields, out HPS.Publish.ImageKit[] out_images)

bool ShowButtonLabelsByField (out string[] out_fields, out string[] out_labels)

bool ShowButtons (out HPS.Publish.ButtonKit[] out_buttons, out HPS.IntRectangle[] out_locations)

Shows the buttons on the page.

Param out_buttons: Buttons on the page.
Param out_locations: Button locations on the page.
Return: true if buttons were specified, false otherwise.

bool ShowCheckBoxes (out HPS.Publish.CheckBoxKit[] out_check_boxes, out HPS.IntRectangle[] out_locations)

Shows the check boxes on the page.

Param out_check_boxes: Check boxes on the page.
Param out_locations: Check box locations on the page.
Return: true if check boxes were specified, false otherwise.

bool ShowDropDownLists (out HPS.Publish.DropDownListKit[] out_drop_down_lists, out HPS.IntRectangle[] out_locations)

Shows the drop down lists on the page.

Param out_drop_down_lists: Drop down lists on the page.
Param out_locations: Drop drown list locations on the page.
Return: true if drop down lists were specified, false otherwise.

bool ShowFormat (out HPS.Publish.Page.Format out_format)

Shows the format of the page.

Param out_format: Format of the page.
Return: true if a format was specified, false otherwise.

bool ShowImages (out HPS.Publish.ImageKit[] out_images, out HPS.IntRectangle[] out_locations)

Shows the images on the page.

Param out_images: Images on the page.
Param out_locations: Image locations on the page.
Return: true if images were specified, false otherwise.

bool ShowJavaScriptActionsByField (out string[] out_fields, out string[] out_sources, out HPS.Publish.Source.Type[] out_types)

bool ShowLinks (out HPS.Publish.LinkKit[] out_links, out HPS.IntRectangle[] out_locations)

Shows the links on the page.

Param out_links: Links on the page.
Param out_locations: Link locations on the page.
Return: true if links were specified, false otherwise.

bool ShowListBoxes (out HPS.Publish.ListBoxKit[] out_list_boxes, out HPS.IntRectangle[] out_locations)

Shows the list boxes on the page.

Param out_list_boxes: List boxes on the page.
Param out_locations: List boxes locations on the page.
Return: true if list boxes were specified, false otherwise.

bool ShowListItemFields (out string[] out_fields)

bool ShowListItemsByField (string in_field, out string[] out_values, out string[] out_export_values)

bool ShowOrientation (out HPS.Publish.Page.Orientation out_orientation)

Shows the orientation of the page.

Param out_orientation: Orientation of the page.
Return: true if an orientation was specified, false otherwise.

bool ShowRadioButtons (out HPS.Publish.RadioButtonKit[] out_radio_buttons, out HPS.IntRectangle[] out_locations)

Shows the radio buttons on the page.

Param out_radio_buttons: Radio buttons on the page.
Param out_locations: Radio buttons locations on the page.
Return: true if radio buttons were specified, false otherwise.

bool ShowSignatureFields (out HPS.Publish.SignatureFieldKit[] out_signature_fields, out HPS.IntRectangle[] out_locations)

Shows the signature fields on the page.

Param out_signature_fields: Signature fields on the page.
Param out_locations: Signature field locations on the page.
Return: true if signature fields were specified, false otherwise.

bool ShowSlideTables (out HPS.Publish.SlideTableKit[] out_slide_tables, out HPS.IntRectangle[] out_locations)

Shows the slide tables on the page.

Param out_slide_tables: Slide tables on the page.
Param out_locations: Slide table locations on the page.
Return: true if slide tables were specified, false otherwise.

bool ShowTables (out HPS.Publish.TableKit[] out_tables, out HPS.IntRectangle[] out_locations)

Shows the tables on the page.

Param out_tables: Tables on the page.
Param out_locations: Table locations on the page.
Return: true if tables were specified, false otherwise.

bool ShowTemplateFile (out string out_filename)

Shows the template file.

Param out_filename: The filename for the PDF file to act as a template.
Return: true if a template file was specified, false otherwise.

bool ShowText (out HPS.Publish.TextKit[] out_text, out HPS.IntRectangle[] out_locations)

Shows the text on the page.

Param out_text: Text on the page.
Param out_locations: Text locations on the page.
Return: true if text strings were specified, false otherwise.

bool ShowTextFields (out HPS.Publish.TextFieldKit[] out_text_fields, out HPS.IntRectangle[] out_locations)

Shows the text fields on the page.

Param out_text_fields: Text fields on the page.
Param out_locations: Text field locations on the page.
Return: true if text fields were specified, false otherwise.

bool ShowTextValuesByField (out string[] out_fields, out string[] out_values)

bool ShowVisibilitiesByField (out string[] out_fields, out bool[] out_states)

HPS.Publish.PageKit UnsetAnnotation (ulong in_index)

Removes the annotation at the given index from the page.

Param in_index: Index of the annotation to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetAnnotationByField (string in_field)

Removes the annotation at the given form field from the page.

Param in_field: UTF8-encoded form field name with the annotation to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetAnnotations ()

Removes all annotations from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetAnnotations (ulong[] in_indices)

Removes the annotations at the given indices from the page.

Param in_indices: Indices of the annotations to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetAnnotationsByField ()

Removes all annotation form fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetAnnotationsByField (string[] in_fields)

Removes the annotations at the given form fields from the page.

Param in_fields: Form field names with the annotations to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButton (ulong in_index)

Removes the button at the given index from the page.

Param in_index: Index of the button to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtonIconByField (string in_field)

Removes the image on the icon at the given form field from the page.

Param in_field: UTF8-encoded form field name of the icon with the image to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtonIconsByField ()

Removes all button icon form fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtonIconsByField (string[] in_fields)

Removes the images on the icons at the given form fields from the page.

Param in_fields: Form field names of icons with the images to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtonLabelByField (string in_field)

Removes the label at the given form field from the page.

Param in_field: UTF8-encoded form field name of the label to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtonLabelsByField ()

Removes all button label form fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtonLabelsByField (string[] in_fields)

Removes the labels at the given form fields from the page.

Param in_fields: Form field names of the labels to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtons ()

Removes all buttons from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetButtons (ulong[] in_indices)

Removes the buttons at the given indices from the page.

Param in_indices: Indices of the buttons to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetCheckBox (ulong in_index)

Removes the check box at the given index from the page.

Param in_index: Index of the check box to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetCheckBoxes ()

Removes all check boxes from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetCheckBoxes (ulong[] in_indices)

Removes the check box at the given indices from the page.

Param in_indices: Indices of the check box to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetDropDownList (ulong in_index)

Removes the drop down list at the given index from the page.

Param in_index: Index of the drop down list to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetDropDownLists ()

Removes all drop down lists from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetDropDownLists (ulong[] in_indices)

Removes the drop down list at the given indices from the page.

Param in_indices: Indices of the drop down list to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetEverything ()

Removes all data from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetFormat ()

Removes the format from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetImage (ulong in_index)

Removes the image at the given index from the page.

Param in_index: Index of the image to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetImages ()

Removes all images from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetImages (ulong[] in_indices)

Removes the images at the given indices from the page.

Param in_indices: Indices of the images to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetJavaScriptActionByField (string in_field)

Removes the JavaScript action at the given form field from the page.

Param in_field: UTF8-encoded form field name of the action to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetJavaScriptActionsByField ()

Removes all JavaScript action form fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetJavaScriptActionsByField (string[] in_fields)

Removes the JavaScript actions at the given form fields from the page.

Param in_fields: Form field names of the actions to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetLink (ulong in_index)

Removes the link at the given index from the page.

Param in_index: Index of the link to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetLinks ()

Removes all links from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetLinks (ulong[] in_indices)

Removes the links at the given indices from the page.

Param in_indices: Indices of the links to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListBox (ulong in_index)

Removes the list box at the given index from the page.

Param in_index: Index of the list box to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListBoxes ()

Removes all list boxes from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListBoxes (ulong[] in_indices)

Removes the list box at the given indices from the page.

Param in_indices: Indices of the list box to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListItemByField (string in_field, ulong in_index)

Removes the item at the given index from the list at the given form field from the page.

Param in_field: UTF8-encoded form field name of the list with the item to be removed.
Param in_index: Index of the item in the list at the given form field to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListItemsByField ()

Removes all list item form fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListItemsByField (string in_field)

Removes all items from the list at the given form field from the page.

Param in_field: UTF8-encoded form field name of the list with the items to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListItemsByField (string in_field, ulong[] in_indices)

Removes the items at the given indices from the list at the given form field from the page.

Param in_field: UTF8-encoded form field name of the list with the items to be removed.
Param in_indices: Indices of the items in the list at the form field to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetListItemsByField (string[] in_fields)

Removes all items from the lists at the given form fields from the page.

Param in_fields: Form field names of the lists with the items to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetOrientation ()

Removes the orientation from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetRadioButton (ulong in_index)

Removes the radio button at the given index from the page.

Param in_index: Index of the radio button to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetRadioButtons ()

Removes all radio buttons from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetRadioButtons (ulong[] in_indices)

Removes the radio button at the given indices from the page.

Param in_indices: Indices of the radio button to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetSignatureField (ulong in_index)

Removes the signature field at the given index from the page.

Param in_index: Index of the signature field to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetSignatureFields ()

Removes all signature fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetSignatureFields (ulong[] in_indices)

Removes the signature field at the given indices from the page.

Param in_indices: Indices of the signature field to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetSlideTable (ulong in_index)

Removes the slide table at the given index from the page.

Param in_index: Index of the slide table to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetSlideTables ()

Removes all slide tables from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetSlideTables (ulong[] in_indices)

Removes the slide tables at the given indices from the page.

Param in_indices: Indices of the slide tables to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTable (ulong in_index)

Removes the table at the given index from the page.

Param in_index: Index of the table to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTables ()

Removes all tables from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTables (ulong[] in_indices)

Removes the tables at the given indices from the page.

Param in_indices: Indices of the tables to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTemplateFile ()

Removes the template file from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetText ()

Removes all text from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetText (ulong in_index)

Removes the text at the given index from the page.

Param in_index: Index of the text to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetText (ulong[] in_indices)

Removes the text at the given indices from the page.

Param in_indices: Indices of the text to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTextField (ulong in_index)

Removes the text field at the given index from the page.

Param in_index: Index of the text field to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTextFields ()

Removes all text fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTextFields (ulong[] in_indices)

Removes the text fields at the given indices from the page.

Param in_indices: Indices of the text fields to remove from the page.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTextValueByField (string in_field)

Removes the text value at the given form field from the page.

Param in_field: UTF8-encoded form field name with the text value to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTextValuesByField ()

Removes all text value form fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetTextValuesByField (string[] in_fields)

Removes the text values at the given form fields from the page.

Param in_fields: Form field names with the text values to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetVisibilitiesByField ()

Removes all visibility settings on form fields from the page.

Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetVisibilitiesByField (string[] in_fields)

Removes the visibility settings at the given form fields from the page.

Param in_fields: Form field names with the visibility settings to be removed.
Return: A reference to this PageKit.

HPS.Publish.PageKit UnsetVisibilityByField (string in_field)

Removes the visibility setting at the given form field from the page.

Param in_field: UTF8-encoded form field name with the visibility setting to be removed.
Return: A reference to this PageKit.

Public Static Functions

HPS.Publish.PageKit GetDefault ()

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

Return: A PageKit with the default settings.

bool operator!= (HPS.Publish.PageKit a, HPS.Publish.PageKit b)

bool operator== (HPS.Publish.PageKit a, HPS.Publish.PageKit b)

class Permission : public IDisposable 

The Publish.Permission class is a concept class for permission-related enumerations.

Public Functions

void Dispose ()

Permission (HPS.Publish.Permission in_that)

class PRC : public IDisposable 

The Publish.PRC class is a concept class for PRC-related enums.

Public Types

enum BRepCompression

Enumerates the compression to apply to BRep data when exporting a PRC file.

Values:

None: No compression (A3DRWParamsExportPrcData::m_bCompressBrep = false).

Low: Low compression, high accurracy (kA3DCompressionLow).

Medium: Medium compression, medium accurracy (kA3DCompressionMedium).

High: High compression, low accurracy (kA3DCompressionHigh).

Public Functions

void Dispose ()

PRC (HPS.Publish.PRC in_that)

class RadioButtonKit : public HPS.SprocketKit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this RadioButtonKit has any values set on it.

Return: true if no values are set on this RadioButtonKit, false otherwise.

bool Equals (HPS.Publish.RadioButtonKit in_kit)

Check if the source RadioButtonKit is equivalent to this RadioButtonKit.

Param in_kit: The source RadioButtonKit to compare to this RadioButtonKit.
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.

RadioButtonKit (): The default constructor creates an empty RadioButtonKit object.

RadioButtonKit (HPS.Publish.RadioButtonKit in_kit)

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

Param in_kit: The source RadioButtonKit to copy.

void Set (HPS.Publish.RadioButtonKit in_kit)

Copies the source RadioButtonKit into this RadioButtonKit.

Param in_kit: The source RadioButtonKit to copy.

HPS.Publish.RadioButtonKit SetBorder (bool in_state)

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

Param in_state: Whether the radio button has a border.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetBorderColor (HPS.RGBColor in_color)

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

Param in_color: The border color of the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetBorderStyle (HPS.Publish.Border.Style in_style)

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

Param in_style: The border style for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

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

Param in_thickness: The border thickness for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetDefaultState (bool in_state)

Sets whether the radio button is checked by default. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsCheckedByDefault.

Param in_state: Whether the radio button is checked by default.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit 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 A3DPDFRadioButtonData::m_pcExportValue.

Param in_export_value: UTF8-encoded export value of the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFillColor (HPS.RGBColor in_color)

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

Param in_color: The fill color for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFont (HPS.Publish.Text.Font.Name in_name)

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

Param in_name: The builtin font for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFont (string in_name)

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

Param in_name: UTF8-encoded font name for the radio button.
Return: A reference to this RadioButtonKit.

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

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

Param in_name: UTF8-encoded font name for the radio button.
Param in_style: The style of font to use for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFontSize (int in_size)

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

Param in_size: The font size for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetGrouping (bool in_state)

Sets whether the radio buttons with the same names are grouped, and therefore mutually exclusive. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bRadiosInUnison.

Param in_state: Whether the radio button is part of a group.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetLock (bool in_state)

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

Param in_state: Whether the radio button is locked.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetName (string in_name)

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

Param in_name: UTF8-encoded name of the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetPrintability (bool in_state)

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

Param in_state: The printability for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetTextColor (HPS.RGBColor in_color)

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

Param in_color: The text color for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

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

Param in_rotation: The text rotation for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetTooltip (string in_tooltip)

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

Param in_tooltip: UTF8-encoded tooltip text for the radio button.
Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetVisibility (bool in_state)

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

Param in_state: The visibility for the radio button.
Return: A reference to this RadioButtonKit.

void Show (out HPS.Publish.RadioButtonKit out_kit)

Copies this RadioButtonKit into the given RadioButtonKit.

Param out_kit: The RadioButtonKit to populate with the contents of this RadioButtonKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the radio button.

Param out_state: Whether the radio 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 radio button.

Param out_color: The border color of the radio 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 radio button.

Param out_style: The border style for the radio 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 radio button.

Param out_thickness: The border thickness for the radio button.
Return: true if a border thickness was specified, false otherwise.

bool ShowDefaultState (out bool out_default_state)

Shows the default state for the radio button.

Param out_default_state: The default state for the radio button.
Return: true if a default state was specified, false otherwise.

bool ShowExportValue (out string out_export_value)

Shows the export value for the radio button.

Param out_export_value: The export value for the radio button.
Return: true if an export value was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the radio button.

Param out_color: The fill color for the radio 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 radio button.

Param out_type: The type of font for the radio button.
Param out_font: The built-in font for the radio button. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the radio button. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_style: The font style for the radio 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 radio button.

Param out_size: The font size for the radio button.
Return: true if a font size was specified, false otherwise.

bool ShowGrouping (out bool out_grouping)

Shows the grouping state for the radio button.

Param out_grouping: The grouping state for the radio button.
Return: true if a groupings state was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the radio button.

Return: true if a lock setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the radio button.

Param out_name: The name of the radio button.
Return: true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the radio button.

Param out_state: The printability for the radio button.
Return: true if a printability was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the radio button.

Param out_color: The text color for the radio 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 radio button.

Param out_rotation: The text rotation for the radio button.
Return: true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the radio button.

Param out_tooltip: The tooltip text for the radio button.
Return: true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the radio button.

Param out_state: The visibility for the radio button.
Return: true if a visibility was specified, false otherwise.

HPS.Publish.RadioButtonKit UnsetBorder ()

Removes the border setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetDefaultState ()

Removes the default state setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetEverything ()

Removes all data from the radio button.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetExportValue ()

Removes the export value setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetFont ()

Removes the font setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetGrouping ()

Removes the grouping setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetLock ()

Removes the lock setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetName ()

Removes the name setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this RadioButtonKit.

Public Static Functions

HPS.Publish.RadioButtonKit GetDefault ()

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

Return: A RadioButtonKit with the default settings.

bool operator!= (HPS.Publish.RadioButtonKit a, HPS.Publish.RadioButtonKit b)

bool operator== (HPS.Publish.RadioButtonKit a, HPS.Publish.RadioButtonKit b)

class Rendering : public IDisposable 

The Publish.Rendering class is a concept class for rendering-related enumerations.

Public Types

enum Mode

Enumerates the rendering modes for ViewKit and AnnotationKit objects.

Values:

Solid: Displays textured and lit faces (kA3DPDFRenderingSolid).

SolidWireframe: Displays textured and lit faces and monochromatic tessellation edges (kA3DPDFRenderingSolidWireframe).

SolidOutline: Displays textured and lit faces and monochromatic silhouette edges (kA3DPDFRenderingSolidOutline).

BoundingBox: Displays monochromatic edges of bounding boxes for each node (kA3DPDFRenderingBoundingBox).

Transparent: Displays textured and lit transparent faces (kA3DPDFRenderingTransparent).

TransparentWireframe: Displays textured and lit transparent faces and monochromatic tessellation edges (kA3DPDFRenderingTransparentWireframe).

TransparentBoundingBox: Displays monochromatic transparent faces of bounding boxes for each node (kA3DPDFRenderingTransparentBoundingBox).

TransparentBoundingBoxOutline: Displays monochromatic edges and transparent faces of bounding boxes for each node (kA3DPDFRenderingTransparentBoundingBoxOutline).

Illustration: Displays monochromatic unlit faces and silhouette edges (kA3DPDFRenderingIllustration).

ShadedIllustration: Displays textured and lit faces with increased emissivity and monochromatic silhouette edges (kA3DPDFRenderingShadedIllustration).

Wireframe: Displays monochromatic tessellation edges (kA3DPDFRenderingWireframe).

ShadedWireframe: Displays color interpolated and lit tessellation edges (kA3DPDFRenderingShadedWireframe).

HiddenWireframe: Displays monochromatic faces and tessellation edges (kA3DPDFRenderingHiddenWireframe).

Vertices: Displays monochromatic vertices (kA3DPDFRenderingVertices).

ShadedVertices: Displays colored and lit vertices (kA3DPDFRenderingShadedVertices).

Public Functions

void Dispose ()

Rendering (HPS.Publish.Rendering in_that)

class SignatureFieldKit : public HPS.SprocketKit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this SignatureFieldKit has any values set on it.

Return: true if no values are set on this SignatureFieldKit, false otherwise.

bool Equals (HPS.Publish.SignatureFieldKit in_kit)

Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.

Param in_kit: The source SignatureFieldKit to compare to this SignatureFieldKit.
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.SignatureFieldKit in_kit)

Copies the source SignatureFieldKit into this SignatureFieldKit.

Param in_kit: The source SignatureFieldKit to copy.

HPS.Publish.SignatureFieldKit SetBorder (bool in_state)

Sets whether the signature field has a border. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bHasBorder.

Param in_state: Whether the signature field has a border.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetBorderColor (HPS.RGBColor in_color)

Sets the border color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sBorderColor.

Param in_color: The border color of the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetBorderStyle (HPS.Publish.Border.Style in_style)

Sets the border style for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eLineStyleBorder.

Param in_style: The border style for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

Sets the border thickness for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eThicknessBorder.

Param in_thickness: The border thickness for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetFillColor (HPS.RGBColor in_color)

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

Param in_color: The fill color for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetFont (HPS.Publish.Text.Font.Name in_name)

Sets a builtin font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.

Param in_name: The builtin font for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetFont (string in_name)

Sets a specific font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.

Param in_name: UTF8-encoded font name for the signature field.
Return: A reference to this SignatureFieldKit.

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

Sets a specific font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.

Param in_name: UTF8-encoded font name for the signature field.
Param in_style: The style of font to use for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetFontSize (int in_size)

Sets the font size for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_iFontSize.

Param in_size: The font size for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetLock (bool in_state)

Sets whether the signature field is locked. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bIsLocked.

Param in_state: Whether the signature field is locked.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetName (string in_name)

Sets the name of the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcName.

Param in_name: UTF8-encoded name of the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetPrintability (bool in_state)

Sets the printability for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.

Param in_state: The printability for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetTextColor (HPS.RGBColor in_color)

Sets the text color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sTextColor.

Param in_color: The text color for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

Sets the text rotation for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eTextOrientation.

Param in_rotation: The text rotation for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetTooltip (string in_tooltip)

Sets the tooltip for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcTooltip.

Param in_tooltip: UTF8-encoded tooltip text for the signature field.
Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit SetVisibility (bool in_state)

Sets the visibility for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.

Param in_state: The visibility for the signature field.
Return: A reference to this SignatureFieldKit.

void Show (out HPS.Publish.SignatureFieldKit out_kit)

Copies this SignatureFieldKit into the given SignatureFieldKit.

Param out_kit: The SignatureFieldKit to populate with the contents of this SignatureFieldKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the signature field.

Param out_state: Whether the signature field 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 signature field.

Param out_color: The border color of the signature field.
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 signature field.

Param out_style: The border style for the signature field.
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 signature field.

Param out_thickness: The border thickness for the signature field.
Return: true if a border thickness was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the signature field.

Param out_color: The fill color for the signature field.
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 signature field.

Param out_type: The type of font for the signature field.
Param out_font: The built-in font for the signature field. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the signature field. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_style: The font style for the signature field. 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 signature field.

Param out_size: The font size for the signature field.
Return: true if a font size was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the signature field.

Return: true if a lock setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the signature field.

Param out_name: The name of the signature field.
Return: true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the signature field.

Param out_state: The printability for the signature field.
Return: true if a printability was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the signature field.

Param out_color: The text color for the signature field.
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 signature field.

Param out_rotation: The text rotation for the signature field.
Return: true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the signature field.

Param out_tooltip: The tooltip text for the signature field.
Return: true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the signature field.

Param out_state: The visibility for the signature field.
Return: true if a visibility was specified, false otherwise.

SignatureFieldKit (): The default constructor creates an empty SignatureFieldKit object.

SignatureFieldKit (HPS.Publish.SignatureFieldKit in_kit)

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

Param in_kit: The source SignatureFieldKit to copy.

HPS.Publish.SignatureFieldKit UnsetBorder ()

Removes the border setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetEverything ()

Removes all data from the signature field.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetFont ()

Removes the font setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetLock ()

Removes the lock setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetName ()

Removes the name setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this SignatureFieldKit.

HPS.Publish.SignatureFieldKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this SignatureFieldKit.

Public Static Functions

HPS.Publish.SignatureFieldKit GetDefault ()

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

Return: A SignatureFieldKit with the default settings.

bool operator!= (HPS.Publish.SignatureFieldKit a, HPS.Publish.SignatureFieldKit b)

bool operator== (HPS.Publish.SignatureFieldKit a, HPS.Publish.SignatureFieldKit b)

class SlideTableKit : public HPS.SprocketKit 

The SlideTableKit class is a user space object. It acts as the container for all data that can be used to specify a slide table for a Publish

PDF.

The TableToPDF

Publish add-on must be installed in order to use this class.

Warning

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this SlideTableKit has any values set on it.

Return: true if no values are set on this SlideTableKit, false otherwise.

bool Equals (HPS.Publish.SlideTableKit in_kit)

Check if the source SlideTableKit is equivalent to this SlideTableKit.

Param in_kit: The source SlideTableKit to compare to this SlideTableKit.
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.SlideTableKit in_kit)

Copies the source SlideTableKit into this SlideTableKit.

Param in_kit: The source SlideTableKit to copy.

HPS.Publish.SlideTableKit SetButtons (string in_previous_button_name, string in_next_button_name)

Sets the button names for the slide table.

Param in_previous_button_name: UTF8-encoded name for the previous button.
Param in_next_button_name: UTF8-encoded name for the next button.
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit SetHeader (bool in_state)

Sets whether this slide table has a header.

Param in_state: Whether this slide table has a header.
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit SetHTML (string in_source)

Sets the HTML table source or file.

Param in_source: UTF8-encoded HTML table source or file (depending on the following argument).
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit SetHTML (string in_source, HPS.Publish.Source.Type in_type)

Sets the HTML table source or file.

Param in_source: UTF8-encoded HTML table source or file (depending on the following argument).
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit SetHTMLStyle (string in_source)

Sets the HTML table style source or file.

Param in_source: UTF8-encoded HTML table style source or file (depending on the following argument).
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type)

Sets the HTML table style source or file.

Param in_source: UTF8-encoded HTML table style source or file (depending on the following argument).
Param in_type: Type of the preceding argument.
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit SetText (ulong in_rows, ulong in_columns, HPS.Publish.TextFieldKit[] in_text)

Sets the text strings for the slide table.

Param in_rows: Number of rows.
Param in_columns: Number of columns.
Param in_text: Text strings for the slide table. This array should be of size in_rows * in_columns.
Return: A reference to this SlideTableKit.

void Show (out HPS.Publish.SlideTableKit out_kit)

Copies this SlideTableKit into the given SlideTableKit.

Param out_kit: The SlideTableKit to populate with the contents of this SlideTableKit.

bool ShowButtons (out string out_previous_button_name, out string out_next_button_name)

Shows the buttons setting.

Param out_previous_button_name: Name for the previous button.
Param out_next_button_name: Name for the next button.
Return: true if button names were specified, false otherwise.

bool ShowHeader (out bool out_state)

Shows the header setting.

Param out_state: Whether this slide table has a header.
Return: true if a header setting was specified, false otherwise.

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

Shows the HTML table setting.

Param out_source: The HTML table source or file (depending on the following argument).
Param out_type: The type of the preceding argument.
Return: true if an HTML table was specified, false otherwise.

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

Shows the HTML table style setting.

Param out_source: The HTML table style source or file (depending on the following argument).
Param out_type: The type of the preceding argument.
Return: true if an HTML table style was specified, false otherwise.

bool ShowText (out ulong out_rows, out ulong out_columns, out HPS.Publish.TextFieldKit[] out_text)

Shows the text strings setting.

Param out_rows: Number of rows.
Param out_columns: Number of columns.
Param out_text: Text strings for the slide table.
Return: true if text strings were specified, false otherwise.

SlideTableKit (): The default constructor creates an empty SlideTableKit object.

SlideTableKit (HPS.Publish.SlideTableKit in_kit)

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

Param in_kit: The source SlideTableKit to copy.

HPS.Publish.SlideTableKit UnsetButtons ()

Removes the buttons setting.

Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit UnsetEverything ()

Removes all data from the table.

Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit UnsetHeader ()

Removes the header setting.

Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit UnsetHTML ()

Removes the HTML table setting.

Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit UnsetHTMLStyle ()

Removes the HTML table style setting.

Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit UnsetText ()

Removes the text strings setting.

Return: A reference to this SlideTableKit.

Public Static Functions

bool operator!= (HPS.Publish.SlideTableKit a, HPS.Publish.SlideTableKit b)

bool operator== (HPS.Publish.SlideTableKit a, HPS.Publish.SlideTableKit b)

class Source : public IDisposable 

The Publish.Source class is a concept class for source-string-related enums.

Public Functions

void Dispose ()

Source (HPS.Publish.Source in_that)

class TableKit : public HPS.SprocketKit 

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

PDF.

The TableToPDF

Publish add-on must be installed in order to use this class.

Warning

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this TableKit has any values set on it.

Return: true if no values are set on this TableKit, false otherwise.

bool Equals (HPS.Publish.TableKit in_kit)

Check if the source TableKit is equivalent to this TableKit.

Param in_kit: The source TableKit to compare to this TableKit.
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.TableKit in_kit)

Copies the source TableKit into this TableKit.

Param in_kit: The source TableKit to copy.

HPS.Publish.TableKit SetButton (int in_row, int in_column, HPS.Publish.ButtonKit in_button)

Adds a button to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertButtonInTable.

Param in_row: Row in which to add the button.
Param in_column: Column in which to add the button.
Param in_button: Button to add at the specified row and column in the table.
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTML (string in_source)

Sets the HTML table source or file.

Param in_source: UTF8-encoded HTML table source or file (depending on the following argument).
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTML (string in_source, HPS.Publish.Source.Type in_type)

Sets the HTML table source or file.

Param in_source: UTF8-encoded HTML table source or file (depending on the following argument).
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTMLStyle (string in_source)

Sets the HTML table style source or file.

Param in_source: UTF8-encoded HTML table style source or file (depending on the following argument).
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type)

Sets the HTML table style source or file.

Param in_source: UTF8-encoded HTML table style source or file (depending on the following argument).
Param in_type: Type of the preceding argument.
Return: A reference to this TableKit.

HPS.Publish.TableKit SetLink (int in_row, int in_column, HPS.Publish.LinkKit in_link)

Adds a link to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertLinkInTable.

Param in_row: Row in which to add the link.
Param in_column: Column in which to add the link.
Param in_link: Link to add at the specified row and column in the table.
Return: A reference to this TableKit.

HPS.Publish.TableKit SetText (int in_row, int in_column, HPS.Publish.TextKit in_text)

Adds text to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextInTable.

Param in_row: Row in which to add the text.
Param in_column: Column in which to add the text.
Param in_text: Text to add at the specified row and column in the table.
Return: A reference to this TableKit.

HPS.Publish.TableKit SetTextField (int in_row, int in_column, HPS.Publish.TextFieldKit in_text_field)

Adds a text field to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextFieldInTable.

Param in_row: Row in which to add the text field.
Param in_column: Column in which to add the text field.
Param in_text_field: Text field to add at the specified row and column in the table.
Return: A reference to this TableKit.

void Show (out HPS.Publish.TableKit out_kit)

Copies this TableKit into the given TableKit.

Param out_kit: The TableKit to populate with the contents of this TableKit.

bool ShowButton (int in_row, int in_column, out HPS.Publish.ButtonKit out_button)

Shows the button at the specified row and column.

Param in_row: Row in which to show the button.
Param in_column: Column in which to show the button.
Param out_button: The button at the specified row and column in the table.
Return: true if a button was added at the specified row and column, false otherwise.

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

Shows the HTML table setting.

Param out_source: The HTML table source or file (depending on the following argument).
Param out_type: The type of the preceding argument.
Return: true if an HTML table was specified, false otherwise.

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

Shows the HTML table style setting.

Param out_source: The HTML table style source or file (depending on the following argument).
Param out_type: The type of the preceding argument.
Return: true if an HTML table style was specified, false otherwise.

bool ShowLink (int in_row, int in_column, out HPS.Publish.LinkKit out_link)

Shows the link at the specified row and column.

Param in_row: Row in which to show the link.
Param in_column: Column in which to show the link.
Param out_link: The link at the specified row and column in the table.
Return: true if a link was added at the specified row and column, false otherwise.

bool ShowText (int in_row, int in_column, out HPS.Publish.TextKit out_text)

Shows the text at the specified row and column.

Param in_row: Row in which to show the text.
Param in_column: Column in which to show the text.
Param out_text: The text at the specified row and column in the table.
Return: true if text was added at the specified row and column, false otherwise.

bool ShowTextField (int in_row, int in_column, out HPS.Publish.TextFieldKit out_text_field)

Shows the link at the specified row and column.

Param in_row: Row in which to show the link.
Param in_column: Column in which to show the link.
Param out_text_field: The text field at the specified row and column in the table.
Return: true if a link was added at the specified row and column, false otherwise.

TableKit (): The default constructor creates an empty TableKit object.

TableKit (HPS.Publish.TableKit in_kit)

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

Param in_kit: The source TableKit to copy.

HPS.Publish.TableKit UnsetButton (int in_row, int in_column)

Removes the button at the specified row and column.

Return: A reference to this TableKit.

HPS.Publish.TableKit UnsetEverything ()

Removes all data from the table.

Return: A reference to this TableKit.

HPS.Publish.TableKit UnsetHTML ()

Removes the HTML table setting.

Return: A reference to this TableKit.

HPS.Publish.TableKit UnsetHTMLStyle ()

Removes the HTML table style setting.

Return: A reference to this TableKit.

HPS.Publish.TableKit UnsetLink (int in_row, int in_column)

Removes the link at the specified row and column.

Return: A reference to this TableKit.

HPS.Publish.TableKit UnsetText (int in_row, int in_column)

Removes the text at the specified row and column.

Return: A reference to this TableKit.

HPS.Publish.TableKit UnsetTextField (int in_row, int in_column)

Removes the text field at the specified row and column.

Return: A reference to this TableKit.

Public Static Functions

bool operator!= (HPS.Publish.TableKit a, HPS.Publish.TableKit b)

bool operator== (HPS.Publish.TableKit a, HPS.Publish.TableKit b)

class Text : public IDisposable 

The Publish.Text class is a concept class for text-related enumerations.

Public Types

enum Language

Enumerates the supported languages for explicitly-specified fonts.

Values:

ASCII: Self-explanatory.

EastEuropeanRoman: Self-explanatory.

Cyrillic: Self-explanatory.

Greek: Self-explanatory.

Turkish: Self-explanatory.

Hebrew: Self-explanatory.

Arabic: Self-explanatory.

Baltic: Self-explanatory.

ChineseTraditional: Self-explanatory.

ChineseSimplified: Self-explanatory.

Japanese: Self-explanatory.

Korean: Self-explanatory.

enum Rotation

Enumerates the rotation to use for text strings.

Values:

None: No rotation, text will be horizontal (kA3DPDFNormal).

CounterClockwise90Degrees: Text will be rotated 90 degrees counter-clockwise from the horizontal (kA3DPDF90).

CounterClockwise180Degrees: Text will be rotated 180 degrees counter-clockwise from the horizontal (kA3DPDF180).

CounterClockwise270Degrees: Text will be rotated 270 degrees counter-clockwise from the horizontal (kA3DPDF270).

Public Functions

void Dispose ()

Text (HPS.Publish.Text in_that)

class Font : public IDisposable 

The Publish.Text.Font class is a concept class for text-font-related enumerations.

Public Types

enum Name

Enumerates the built-in fonts available for text strings.

Values:

TimesRoman: Standard Times Roman font (kA3DPDFFontTimesRoman).

TimesItalic: Italic Times Roman font (kA3DPDFFontTimesItalic).

TimesBold: Bold Times Roman font (kA3DPDFFontTimesBold).

TimesBoldItalic: Bold Italic Times Roman font (kA3DPDFFontTimesBoldItalic).

Helvetica: Standard Helvetica font (kA3DPDFFontHelvetica).

HelveticaOblique: Oblique Helvetica font (kA3DPDFFontHelveticaOblique).

HelveticaBold: Bold Helvetica font (kA3DPDFFontHelveticaBold).

HelveticaBoldOblique: Bold Oblique Helvetica font (kA3DPDFFontHelveticaBoldOblique).

Courier: Standard Courier font (kA3DPDFFontCourier).

CourierOblique: Oblique Courier font (kA3DPDFFontCourierOblique).

CourierBold: Bold Courier font (kA3DPDFFontCourierBold).

CourierBoldOblique: Bold Oblique Courier font (kA3DPDFFontCourierBoldOblique).

enum Style

Enumerates the font styles to use for text strings.

Values:

Regular: Regular font style.

Bold: Bold font style.

Italic: Italic font style.

BoldItalic: Bold and italic font style.

Public Functions

void Dispose ()

Font (HPS.Publish.Text.Font in_that)

class TextFieldKit : public HPS.SprocketKit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this TextFieldKit has any values set on it.

Return: true if no values are set on this TextFieldKit, false otherwise.

bool Equals (HPS.Publish.TextFieldKit in_kit)

Check if the source TextFieldKit is equivalent to this TextFieldKit.

Param in_kit: The source TextFieldKit to compare to this TextFieldKit.
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.TextFieldKit in_kit)

Copies the source TextFieldKit into this TextFieldKit.

Param in_kit: The source TextFieldKit to copy.

HPS.Publish.TextFieldKit SetBorder (bool in_state)

Sets whether the text field has a border. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bHasBorder.

Param in_state: Whether the text field has a border.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetBorderColor (HPS.RGBColor in_color)

Sets the border color for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_sBorderColor.

Param in_color: The border color of the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetBorderStyle (HPS.Publish.Border.Style in_style)

Sets the border style for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eLineStyleBorder.

Param in_style: The border style for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

Sets the border thickness for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eThicknessBorder.

Param in_thickness: The border thickness for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetDefaultValue (string in_value)

Sets the default value for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcDefaultValue.

Param in_value: UT8-encoded default value for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFillColor (HPS.RGBColor in_color)

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

Param in_color: The fill color for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFont (HPS.Publish.Text.Font.Name in_name)

Sets a builtin font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.

Param in_name: The builtin font for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFont (string in_name)

Sets a specific font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.

Param in_name: UTF8-encoded font name for the text field.
Return: A reference to this TextFieldKit.

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

Sets a specific font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.

Param in_name: UTF8-encoded font name for the text field.
Param in_style: The style of font to use for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFontSize (int in_size)

Sets the font size for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_iFontSize.

Param in_size: The font size for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetLock (bool in_state)

Sets whether the text field is locked. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bIsLocked.

Param in_state: Whether the text field is locked.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetMultiline (bool in_state)

Sets whether the text field is multiline. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bMultiline.

Param in_state: Whether the text field is multiline.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetName (string in_name)

Sets the name of the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcName.

Param in_name: UTF8-encoded name of the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetPrintability (bool in_state)

Sets the printability for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eFormField.

Param in_state: The printability for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetReadOnly (bool in_state)

Sets whether the text field is read only. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bReadOnly.

Param in_state: Whether the text field can scroll.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetScrolling (bool in_state)

Sets whether the text field can scroll. This corresponds to the (inverted) value that will be passed to A3DPDFTextFieldData::m_bDoNotScroll.

Param in_state: Whether the text field can scroll.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTextColor (HPS.RGBColor in_color)

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

Param in_color: The text color for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTextJustification (HPS.Text.Justification in_justification)

Sets the text justification for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eTextAlignment.

Param in_justification: The text justification for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

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

Param in_rotation: The text rotation for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTooltip (string in_tooltip)

Sets the tooltip for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcTooltip.

Param in_tooltip: UTF8-encoded tooltip text for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetVisibility (bool in_state)

Sets the visibility for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eFormField.

Param in_state: The visibility for the text field.
Return: A reference to this TextFieldKit.

void Show (out HPS.Publish.TextFieldKit out_kit)

Copies this TextFieldKit into the given TextFieldKit.

Param out_kit: The TextFieldKit to populate with the contents of this TextFieldKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the text field.

Param out_state: Whether the text field 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 text field.

Param out_color: The border color of the text field.
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 text field.

Param out_style: The border style for the text field.
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 text field.

Param out_thickness: The border thickness for the text field.
Return: true if a border thickness was specified, false otherwise.

bool ShowDefaultValue (out string out_value)

Shows the default value for the text field.

Param out_value: The default value for the text field.
Return: true if a default value was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the text field.

Param out_color: The fill color for the text field.
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 text field.

Param out_type: The type of font for the text field.
Param out_font: The built-in font for the text field. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the text field. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_style: The font style for the text field. 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 text field.

Param out_size: The font size for the text field.
Return: true if a font size was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the text field.

Return: true if a lock setting was specified, false otherwise.

bool ShowMultiline (out bool out_state)

Shows the multiline setting for the text field.

Param out_state: Whether the text field is multiline.
Return: true if a multiline setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the text field.

Param out_name: The name of the text field.
Return: true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the text field.

Param out_state: The printability for the text field.
Return: true if a printability was specified, false otherwise.

bool ShowReadOnly (out bool out_state)

Shows the read-only setting for the text field.

Param out_state: Whether the text field is read only.
Return: true if a scrolling setting was specified, false otherwise.

bool ShowScrolling (out bool out_state)

Shows the scrolling setting for the text field.

Param out_state: Whether the text field can scroll.
Return: true if a scrolling setting was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the text field.

Param out_color: The text color for the text field.
Return: true if a text color was specified, false otherwise.

bool ShowTextJustification (out HPS.Text.Justification out_justification)

Shows the text justification for the text field.

Param out_justification: The text justification for the text field.
Return: true if a text justification was specified, false otherwise.

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

Shows the text rotation for the text field.

Param out_rotation: The text rotation for the text field.
Return: true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the text field.

Param out_tooltip: The tooltip text for the text field.
Return: true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the text field.

Param out_state: The visibility for the text field.
Return: true if a visibility was specified, false otherwise.

TextFieldKit (): The default constructor creates an empty TextFieldKit object.

TextFieldKit (HPS.Publish.TextFieldKit in_kit)

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

Param in_kit: The source TextFieldKit to copy.

HPS.Publish.TextFieldKit UnsetBorder ()

Removes the border setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetDefaultValue ()

Removes the default value setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetEverything ()

Removes all data from the text field.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetFont ()

Removes the font setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetLock ()

Removes the lock setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetMultiline ()

Removes the multiline setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetName ()

Removes the name setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetReadOnly ()

Removes the read-only setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetScrolling ()

Removes the scrolling setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTextJustification ()

Removes the text justification setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this TextFieldKit.

Public Static Functions

HPS.Publish.TextFieldKit GetDefault ()

Creates a TextFieldKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a text field unless a setting is overridden by the TextFieldKit passed to a function.

Return: A TextFieldKit with the default settings.

bool operator!= (HPS.Publish.TextFieldKit a, HPS.Publish.TextFieldKit b)

bool operator== (HPS.Publish.TextFieldKit a, HPS.Publish.TextFieldKit b)

class TextKit : public HPS.SprocketKit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this TextKit has any values set on it.

Return: true if no values are set on this TextKit, false otherwise.

bool Equals (HPS.Publish.TextKit in_kit)

Check if the source TextKit is equivalent to this TextKit.

Param in_kit: The source TextKit to compare to this TextKit.
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.TextKit in_kit)

Copies the source TextKit into this TextKit.

Param in_kit: The source TextKit to copy.

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

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

Param in_color: Color for the text.
Return: A reference to this TextKit.

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

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

Param in_font: The built-in font for the text.
Return: A reference to this TextKit.

HPS.Publish.TextKit SetFont (string in_font_name, HPS.Publish.Text.Language in_language, bool in_embed_font)

Sets an explicit font for the text. As of Publish 5.11, this is only known to create a valid text string in the PDF if the font name is “MS Gothic” and the language is Japanese, otherwise the creation will fail.

Param in_font_name: UTF8-encoded font name for the text. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_pcFontName.
Param in_language: The language for the font. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_eLanguage.
Param in_embed_font: Whether to embed the font in the PDF. This corresponds to the value that will be passed to A3DPDFTextDataEx::m_bEmbedFontInPDF.
Return: A reference to this TextKit.

HPS.Publish.TextKit SetSize (int in_size)

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

Param in_size: The size in points for the text.
Return: A reference to this TextKit.

HPS.Publish.TextKit SetText (string in_text)

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

Param in_text: UTF8-encoded text string for the text.
Return: A reference to this TextKit.

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

Copies this TextKit into the given TextKit.

Param out_kit: The TextKit to populate with the contents of this TextKit.

bool ShowColor (out HPS.RGBColor out_color)

Shows the color setting

Param out_color: The color for the text.
Return: true if a 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.Language out_language, out bool out_embed_font)

Shows the font setting.

Param out_type: The type of font for the text.
Param out_font: The built-in font for the text. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the text. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_language: The language for the font. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_embed_font: Whether to embed the font in the PDF. This is only valid if out_type is Text.Font.Type.Explicit.
Return: true if a font was specified, false otherwise.

bool ShowSize (out int out_size)

Shows the size setting.

Param out_size: The size for the text.
Return: true if a size was specified, false otherwise.

bool ShowText (out string out_text)

Shows the text string setting.

Param out_text: The text string for the text.
Return: true if a text string was specified, false otherwise.

TextKit (): The default constructor creates an empty TextKit object.

TextKit (HPS.Publish.TextKit in_kit)

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

Param in_kit: The source TextKit to copy.

HPS.Publish.TextKit UnsetColor ()

Removes the color setting.

Return: A reference to this TextKit.

HPS.Publish.TextKit UnsetEverything ()

Removes all data from the text.

Return: A reference to this TextKit.

HPS.Publish.TextKit UnsetFont ()

Removes the font setting.

Return: A reference to this TextKit.

HPS.Publish.TextKit UnsetSize ()

Removes the size setting.

Return: A reference to this TextKit.

HPS.Publish.TextKit UnsetText ()

Removes the text string setting.

Return: A reference to this TextKit.

Public Static Functions

HPS.Publish.TextKit GetDefault ()

Creates a TextKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the TextKit passed to File.Export.

Return: A TextKit with the default settings.

bool operator!= (HPS.Publish.TextKit a, HPS.Publish.TextKit b)

bool operator== (HPS.Publish.TextKit a, HPS.Publish.TextKit b)

class U3D : public IDisposable 

The Publish.U3D class is a concept class for U3D-related enums.

Public Types

enum Version

Enumerates the version to use when exporting a U3D file.

Values:

ECMA1: ECMA-363, version 1 (kA3DECMA1).

ECMA3: ECMA-363, version 3 (kA3DECMA3).

Public Functions

void Dispose ()

U3D (HPS.Publish.U3D in_that)

class ViewKit : public HPS.SprocketKit 

The ViewKit class is a user space object. It acts as the container for all data that can be set on a view in a Publish PDF.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ViewKit has any values set on it.

Return: true if no values are set on this ViewKit, false otherwise.

bool Equals (HPS.Publish.ViewKit in_kit)

Check if the source ViewKit is equivalent to this ViewKit.

Param in_kit: The source ViewKit to compare to this ViewKit.
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.ViewKit in_kit)

Copies the source ViewKit into this ViewKit.

Param in_kit: The source ViewKit to copy.

HPS.Publish.ViewKit SetBackgroundColor (HPS.RGBColor in_color)

Sets the background color for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_sViewBackgroundColor.

Param in_color: The background color for the view.
Return: A reference to this ViewKit.

HPS.Publish.ViewKit SetCamera (HPS.CameraKit in_camera)

Sets the camera for the view. This corresponds to the values that will be passed to A3DPDFViewData::m_sPosition, A3DPDFViewData::m_sTarget, A3DPDFViewData::m_sUpVector, A3DPDFViewData::m_dZoomFactor, A3DPDFViewData::m_eProjectionMode, and A3DPDFViewData::m_dFieldOfView.

Param in_camera: The camera for the view.
Return: A reference to this ViewKit.

HPS.Publish.ViewKit SetDefault (bool in_state)

Sets whether this view is the default view. This corresponds to the value that will be passed to A3DPDFViewData::m_bIsDefault.

Param in_state: Whether this view is the default view.
Return: A reference to this ViewKit.

HPS.Publish.ViewKit SetExternalName (string in_name)

Sets the external name for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_pcExternalName.

Param in_name: UTF8-encoded external name for the view.
Return: A reference to this ViewKit.

HPS.Publish.ViewKit SetInternalName (string in_name)

Sets the internal name for the view.

Param in_name: UTF8-encoded internal name for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_pcInternalName.
Return: A reference to this ViewKit.

HPS.Publish.ViewKit SetLighting (HPS.Publish.Lighting.Mode in_mode)

Sets the lighting mode for the view. This corresponds to the value that will be passed to A3DPDFViewData::m_eViewLighting.

Param in_mode: The lighting mode for the view.
Return: A reference to this ViewKit.

HPS.Publish.ViewKit SetRendering (HPS.Publish.Rendering.Mode in_mode)

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

Param in_mode: The rendering mode for the view.
Return: A reference to this ViewKit.

void Show (out HPS.Publish.ViewKit out_kit)

Copies this ViewKit into the given ViewKit.

Param out_kit: The ViewKit to populate with the contents of this ViewKit.

bool ShowBackgroundColor (out HPS.RGBColor out_color)

Shows the background color for the view.

Param out_color: The background color for the view.
Return: true if a background color was specified, false otherwise.

bool ShowCamera (out HPS.CameraKit out_camera)

Shows the camera setting.

Param out_camera: The camera for the view.
Return: true if a camera was specified, false otherwise.

bool ShowDefault (out bool out_state)

Shows the default setting.

Param out_state: Whether this view is the default view.
Return: true if a default setting was specified, false otherwise.

bool ShowExternalName (out string out_name)

Shows the external name setting.

Param out_name: The external name for the view.
Return: true if an external name was specified, false otherwise.

bool ShowInternalName (out string out_name)

Shows the internal name setting.

Param out_name: The internal name for the view.
Return: true if an internal name was specified, false otherwise.

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

Shows the lighting mode for the view.

Param out_mode: The lighting mode for the view.
Return: true if a lighting mode was specified, false otherwise.

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

Shows the rendering mode for the view.

Param out_mode: The rendering mode for the view.
Return: true if a rendering mode was specified, false otherwise.

HPS.Publish.ViewKit UnsetBackgroundColor ()

Removes the background color setting

Return: A reference to this ViewKit.

HPS.Publish.ViewKit UnsetCamera ()

Removes the camera setting.

Return: A reference to this ViewKit.

HPS.Publish.ViewKit UnsetDefault ()

Removes the default setting.

Return: A reference to this ViewKit.

HPS.Publish.ViewKit UnsetEverything ()

Removes all data from the view.

Return: A reference to this ViewKit.

HPS.Publish.ViewKit UnsetExternalName ()

Removes the external name setting.

Return: A reference to this ViewKit.

HPS.Publish.ViewKit UnsetInternalName ()

Removes the internal name setting.

Return: A reference to this ViewKit.

HPS.Publish.ViewKit UnsetLighting ()

Removes the lighting mode setting

Return: A reference to this ViewKit.

HPS.Publish.ViewKit UnsetRendering ()

Removes the rendering mode setting

Return: A reference to this ViewKit.

ViewKit (): The default constructor creates an empty ViewKit object.

ViewKit (HPS.Publish.ViewKit in_kit)

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

Param in_kit: The source ViewKit to copy.

Public Static Functions

HPS.Publish.ViewKit GetDefault ()

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

Return: A ViewKit with the default settings.

bool operator!= (HPS.Publish.ViewKit a, HPS.Publish.ViewKit b)

bool operator== (HPS.Publish.ViewKit a, HPS.Publish.ViewKit b)