Apryse WebViewer

Class: PresetButton

UI.Components. PresetButton

new PresetButton(properties)

Creates a new instance of PresetButton.
Parameters:
Name Type Description
properties Object An object that contains the properties of the PresetButton.
Properties
Name Type Argument Description
buttonType string The type of the button. Refer to: UI.PRESET_BUTTON_TYPES
dataElement string <optional>
 The data element of the preset button.
style object <optional>
 An object defining inline CSS styles for the button, where each key represents a CSS property and its corresponding value.
className string <optional>
 String with CSS classes to be applied to the button, allowing additional styling and customization through external stylesheets.
img string <optional>
 The icon of the button (overrides default icon).
title string <optional>
 The title of the button (overrides default title).
label string <optional>
 The label of the button (overrides default label).
Example
const presetButton = new instance.UI.Components.PresetButton({
  buttonType: 'saveAsButton',
  dataElement: 'presetButton-save'
});

Extends

Members

<static> alignCenterButton

The preset button for center alignment

<static> alignLeftButton

The preset button for left alignment

<static> alignRightButton

The preset button for right alignment

<static> boldButton

The preset button for toggling bold style

<static> contentEditButton

A button that toggles Content Edit Mode.

<static> createPortfolioButton

A button that opens the create portfolio modal.

<static> decreaseIndentButton

The preset button for decreasing indent in the Office Editor

<static> downloadButton

A button that downloads the current document.

<static> filePickerButton

A button that allows the opening of a file as the document in the UI.

<static> formFieldEditButton

A button that toggles form field edit mode.

<static> fullscreenButton

A button that toggles fullscreen mode.

<static> increaseIndentButton

The preset button for increasing indent in the Office Editor

<static> insertImageButton

The preset button for inserting an image in the Office Editor

<static> italicButton

The preset button for toggling italic style

<static> justifyBothButton

The preset button for justified alignment

<static> newDocumentButton

A button that creates a new document.

<static> officeEditorColorPicker

The preset color picker button for the Office Editor

<static> officeEditorToggleNonPrintingCharactersButton

The preset button for toggling non-printing characters in the Office Editor

<static> printButton

A button that prints the document.

<static> redoButton

A button that performs the redo action.

<static> saveAsButton

A button that opens the save as modal.

<static> settingsButton

A button that opens the settings modal.

<static> spreadsheetEditorInsertImageButton

The preset button for inserting an image in the Spreadsheet Editor

<static> toggleAccessibilityModeButton

A button that toggles the accessibility mode on and off.

<static> underlineButton

The preset button for toggling underline style

<static> undoButton

A button that performs the undo action.

Methods

setStyle(style)

Sets the style of the Item (padding, border, background, etc.)
Parameters:
Name Type Description
style Object An object that can change the CSS style of the Item component.
Inherited From: