Interface: ComponentConfiguration

WebPDF.Toolbar. ComponentConfiguration

Specification to define properties for toolbar component.

Properties:
Name Type Argument Default Description
type string

groups, group, panel, tab, button, dropdown, dropdownItem, blank, fileSelector, font, pluginbutton, template type component

name string <optional>

the name identifier of this component

title string <optional>

tab title

tip string <optional>

tooltip title. this property is only available for button, pluginbutton, fileSelector and dropdownItem type component.

tipdesc string <optional>

tooltip content. this property is only available for button, pluginbutton, fileSelector and dropdownItem type component.

text string <optional>

button text. this property is only available for button, pluginbutton, fileSelector and dropdownItem type component.

cls string <optional>

button's class

iconCls string <optional>

button's icon class

layout string <optional>
no

layout of panel or group component:
flow, no, grid

template string <optional>

template content , this property is only available for template type component;

handler function | string

handler of this component.
internal handlers: noop, zoom, zoomIn, zoomOut, fitpage, fitwidth; importform, exportform; exportFDF,exportXFDF, importFDF, importXFDF switcher, save, addtext, edittext, screen, showAllComments, hideAllComments, font, stamp, rotate, filetab, ppo, cpdf_convert, cpdf_register, cpdf_homepage, cpdf_plugin, openfile markApply, inksign, protect.

events object <optional>

component events

Properties
Name Type Argument Description
before handleEventCallback <optional>

Triggerd before handle

after handleEventCallback <optional>

Triggered after handled

tabactive tabactiveEventCallback <optional>

Triggered when the tab active

extend string <optional>

the name of default configuration

sub Array.<WebPDF.Toolbar.ComponentConfiguration> <optional>

sub components. this property is only available for panel or group type component

groups Array.<WebPDF.Toolbar.ComponentConfiguration> <optional>

groups , this property is only available for group type component

orientation string <optional>
'horizontal'

orientation of flow layout. This property is only available for 'flow' type layout.

permissions Array.<string> <optional>

permission name.

params object <optional>

params for handler

Type Definitions


handleEventCallback(component, config, data)

Parameters:
Name Type Description
component WebPDF.Toolbar.Component
config WebPDF.Toolbar.ComponentConfiguration
data any

tabactiveEventCallback(event, activeTab, lastActiveTab)

Parameters:
Name Type Description
event object
activeTab object
lastActiveTab object