Resource Base
Table of contents

Dynamsoft.DDV.Elements

API Index

Methods

API Name Description
<static> getTooltip() Get tooltip object of built-in elements.
<static> setTooltip() Set tooltip to built-in elements.
<static> getDisplayTextConfig() Get DisplayTextConfig object of built-in elements.
<static> setDisplayTextConfig() Set display text of the default element to your own words or language.

Members

  • Dynamsoft.DDV.Elements.Layout
  • Dynamsoft.DDV.Elements.Button

Built-in Elements

Built-in elements have different availability in different types of viewers. They are listed in categories on Built-in Elements page, please refer to it.

Methods

<static> getTooltip()

Get Tooltip object of built-in elements.

Syntax

static getTooltip(): Tooltip;

Return value

A Tooltip object. Please refer to Tooltip.

Example

const mytooltips = Dynamsoft.DDV.Elements.getTooltip();

<static> setTooltip()

Set tooltip to built-in elements.

Syntax

static setTooltip(tooltip: Tooltip): boolean; 

Parameters

tooltip: A Tooltip object to set. Please refer to Tooltip.

Return Value

true: Successfully.

false: Failed.

Code snippet

  • First method
      const mytooltips = Dynamsoft.DDV.Elements.getTooltip();
      mytooltips.Capture = "Capture";
      mytooltips.Flashlight = "Flashlight"
    
      Dynamsoft.DDV.Elements.setTooltip(mytooltips);
    
  • Second method

      Dynamsoft.DDV.Elements.setTooltip({
          Capture: "Capture",
          Flashlight: "Flashlight",
      });
    

Remark

  • Need to be set before creating viewers.

<static> getDisplayTextConfig()

Get DisplayTextConfig object of built-in elements.

Syntax

static getDisplayTextConfig(): DisplayTextConfig;

Return value

A DisplayTextConfig object. Please refer to DisplayTextConfig.

<static> setDisplayTextConfig()

Set display text of the default element to your own words or language.

Syntax

static setDisplayTextConfig(displaytextconfig: DisplayTextConfig): boolean; 

Parameters

displaytextconfig: The DisplayTextConfig object to set. Please refer to DisplayTextConfig.

Return Value

true: Successfully.

false: Failed.

Example

  • First method
      const mytextconfig = Dynamsoft.DDV.Elements.getDisplayTextConfig();
      mytextconfig.FitMode_FitWidth = "Passform Breite";
      mytextconfig.FitMode_FitHeight = "Passform Höhe";
    
      Dynamsoft.DDV.Elements.setDisplayTextConfig(mytextconfig);
    
  • Second method
      Dynamsoft.DDV.Elements.setDisplayTextConfig({
          FitMode_FitWidth: "Passform Breite",
          FitMode_FitHeight: "Passform Höhe",
      });
    

Remark

  • Need to be set before creating viewers.

Members

Dynamsoft.DDV.Elements.Layout

One supported type of UiConfig which is used to configure the layout of user interface.

Please refer to User Interface - Layout.

Dynamsoft.DDV.Elements.Button

One supported type of UiConfig which is used to configure a custom button.

Please refer to Create your own button.

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version(2.0)
    • Version 1.x
      • Version 1.1
    Change +