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> alignBottomButton

A button that aligns cell content to the bottom.

<static> alignCenterButton

A button that aligns text to the center.

<static> alignLeftButton

A button that aligns text to the left.

<static> alignMiddleButton

A button that aligns cell content to the middle.

<static> alignRightButton

A button that aligns text to the right.

<static> alignTopButton

A button that aligns cell content to the top.

<static> boldButton

A button that toggles bold text formatting.

<static> contentEditButton

A button that toggles Content Edit Mode.

<static> continuousPageTransitionButton

A button that sets the document display to continuous page transition mode.

<static> coverLayoutButton

A button that sets the document display to cover page layout mode.

<static> createPortfolioButton

A button that opens the create portfolio modal.

<static> decreaseIndentButton

A button that decreases the text indentation level.

<static> defaultPageTransitionButton

A button that sets the document display to default page transition mode (page-by-page).

<static> doubleLayoutButton

A button that sets the document display to double page layout mode.

<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

A button that increases the text indentation level.

<static> insertImageButton

A button that inserts an image into the document.

<static> italicButton

A button that toggles italic text formatting.

<static> justifyBothButton

A button that justifies text alignment.

<static> newDocumentButton

A button that creates a new document.

<static> officeEditorColorPicker

A button that opens the color picker for text formatting.

<static> officeEditorToggleNonPrintingCharactersButton

A button that toggles the visibility of non-printing characters in the document.

<static> printButton

A button that prints the document.

<static> readerPageTransitionButton

A button that sets the document display to reader page transition mode.

<static> redoButton

A button that performs the redo action.

<static> rotateClockwiseButton

A button that rotates the document pages clockwise by 90 degrees.

<static> rotateCounterClockwiseButton

A button that rotates the document pages counterclockwise by 90 degrees.

<static> saveAsButton

A button that opens the save as modal.

<static> settingsButton

A button that opens the settings modal.

<static> singleLayoutButton

A button that sets the document display to single page layout mode.

<static> spreadsheetEditorInsertImageButton

A button that inserts an image into the spreadsheet.

<static> strikeoutButton

A button that toggles strikeout text formatting.

<static> toggleAccessibilityModeButton

A button that toggles the accessibility mode on and off.

<static> toggleMultiViewerModeButton

A button that toggles multi-viewer mode for viewing documents side-by-side.

<static> underlineButton

A button that toggles underline text formatting.

<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: