Interface CPDFContextMenuConfig

Context menu configuration interface. Used to customize long-press menu options in different modes. For example, selecting a highlight annotation in annotation mode, or long-pressing a blank area in text editing mode.

interface CPDFContextMenuConfig {
    backgroundColor?: `#${string}`;
    fontSize?: number;
    padding?: Padding;
    iconSize?: number;
    global?: { screenshot?: CPDFContextMenuItem<GlobalMenuKey>[] };
    viewMode?: { textSelect?: CPDFContextMenuItem<ViewTextSelectKey>[] };
    annotationMode?: {
        textSelect?: CPDFContextMenuItem<AnnotationTextSelectKey>[];
        longPressContent?: CPDFContextMenuItem<LongPressContentKey>[];
        markupContent?: CPDFContextMenuItem<MarkupContentKey>[];
        soundContent?: CPDFContextMenuItem<SoundContentKey>[];
        inkContent?: CPDFContextMenuItem<InkContentKey>[];
        shapeContent?: CPDFContextMenuItem<ShapeContentKey>[];
        freeTextContent?: CPDFContextMenuItem<FreeTextContentKey>[];
        signStampContent?: CPDFContextMenuItem<SignStampContentKey>[];
        stampContent?: CPDFContextMenuItem<StampContentKey>[];
        linkContent?: CPDFContextMenuItem<LinkContentKey>[];
    };
    contentEditorMode?: {
        editTextAreaContent?: CPDFContextMenuItem<EditTextAreaContentKey>[];
        editSelectTextContent?: CPDFContextMenuItem<EditSelectTextContentKey>[];
        editTextContent?: CPDFContextMenuItem<EditTextContentKey>[];
        imageAreaContent?: CPDFContextMenuItem<ImageAreaContentKey>[];
        imageCropMode?: CPDFContextMenuItem<ImageCropModeKey>[];
        editPathContent?: CPDFContextMenuItem<"delete">[];
        longPressWithEditTextMode?: CPDFContextMenuItem<
            LongPressWithEditTextModeKey,
        >[];
        longPressWithEditImageMode?: CPDFContextMenuItem<
            LongPressWithEditImageModeKey,
        >[];
        longPressWithAllMode?: CPDFContextMenuItem<LongPressWithAllModeKey>[];
        searchReplace?: CPDFContextMenuItem<"replace">[];
    };
    formMode?: {
        textField?: CPDFContextMenuItem<FormPropertiesDeleteKey>[];
        checkBox?: CPDFContextMenuItem<FormPropertiesDeleteKey>[];
        radioButton?: CPDFContextMenuItem<FormPropertiesDeleteKey>[];
        listBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[];
        comboBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[];
        pushButton?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[];
        signatureField?: CPDFContextMenuItem<SignatureFieldKey>[];
    };
}

Index

Properties

backgroundColor? fontSize? padding? iconSize? global? viewMode? annotationMode? contentEditorMode? formMode?

Properties

`Optional`backgroundColor

backgroundColor?: `#${string}`

Background color of the context menu. Only support HEX color format, e.g. #1460F3 Only supported on Android platform.

`Optional`fontSize

fontSize?: number

Font size of the context menu text. defalut value: 14 dp

`Optional`padding

padding?: Padding

Padding of the context menu. Order: [left, top, right, bottom] Only supported on Android platform.

`Optional`iconSize

iconSize?: number

Icon size of the context menu. defalut value: 36 dp

`Optional`global

global?: { screenshot?: CPDFContextMenuItem<GlobalMenuKey>[] }

Type Declaration

Optionalscreenshot?: CPDFContextMenuItem<GlobalMenuKey>[]
Context menu for using the screenshot feature.
Example
```
screenshot: menus('exit', 'share')
```

`Optional`viewMode

viewMode?: { textSelect?: CPDFContextMenuItem<ViewTextSelectKey>[] }

Type Declaration

OptionaltextSelect?: CPDFContextMenuItem<ViewTextSelectKey>[]
Menu options when long-pressing selected text in viewer mode.
Example
```
textSelect: menus('copy')
```

`Optional`annotationMode

Context menu configuration in annotation mode.

Type Declaration

OptionaltextSelect?: CPDFContextMenuItem<AnnotationTextSelectKey>[]
Menu options shown when long-pressing selected text in annotation mode.
Example
```
textSelect: menus('copy', 'highlight', 'underline', 'strikeout', 'squiggly')
```
OptionallongPressContent?: CPDFContextMenuItem<LongPressContentKey>[]
Menu options shown when long-pressing a blank area in the PDF document.
Example
```
longPressContent: menus('paste', 'note', 'textBox', 'stamp', 'image')
```
OptionalmarkupContent?: CPDFContextMenuItem<MarkupContentKey>[]
Menu options shown when selecting markup annotations in annotation mode.
Example
```
markupContent: menus('properties', 'note', 'reply', 'viewReply', 'delete')
```
OptionalsoundContent?: CPDFContextMenuItem<SoundContentKey>[]
Menu options shown for sound annotations in annotation mode.
Example
```
soundContent: menus('reply', 'viewReply', 'play', 'record', 'delete')
```
OptionalinkContent?: CPDFContextMenuItem<InkContentKey>[]
Menu options shown for ink annotations in annotation mode.
Example
```
inkContent: menus('properties', 'note', 'reply', 'viewReply', 'delete')
```
OptionalshapeContent?: CPDFContextMenuItem<ShapeContentKey>[]
Menu options shown for shape annotations in annotation mode. Includes: rectangle, circle, line, and arrow annotations.
Example
```
shapeContent: menus('properties', 'note', 'reply', 'viewReply', 'delete')
```
OptionalfreeTextContent?: CPDFContextMenuItem<FreeTextContentKey>[]
Menu options shown for free text annotations in annotation mode.
Example
```
freeTextContent: menus('properties', 'edit', 'reply', 'viewReply', 'delete')
```
OptionalsignStampContent?: CPDFContextMenuItem<SignStampContentKey>[]
Menu options shown for signature stamp annotations in annotation mode. Includes: sign, delete, and rotate.
Example
```
signStampContent: menus('signHere', 'delete', 'rotate')
```
OptionalstampContent?: CPDFContextMenuItem<StampContentKey>[]
Menu options shown for stamp annotations in annotation mode.
Example
```
stampContent: menus('note', 'reply', 'viewReply', 'delete', 'rotate')
```
OptionallinkContent?: CPDFContextMenuItem<LinkContentKey>[]
Menu options shown for link annotations in annotation mode.
Example
```
linkContent: menus('edit', 'delete')
```

`Optional`contentEditorMode

contentEditorMode?: {
    editTextAreaContent?: CPDFContextMenuItem<EditTextAreaContentKey>[];
    editSelectTextContent?: CPDFContextMenuItem<EditSelectTextContentKey>[];
    editTextContent?: CPDFContextMenuItem<EditTextContentKey>[];
    imageAreaContent?: CPDFContextMenuItem<ImageAreaContentKey>[];
    imageCropMode?: CPDFContextMenuItem<ImageCropModeKey>[];
    editPathContent?: CPDFContextMenuItem<"delete">[];
    longPressWithEditTextMode?: CPDFContextMenuItem<
        LongPressWithEditTextModeKey,
    >[];
    longPressWithEditImageMode?: CPDFContextMenuItem<
        LongPressWithEditImageModeKey,
    >[];
    longPressWithAllMode?: CPDFContextMenuItem<LongPressWithAllModeKey>[];
    searchReplace?: CPDFContextMenuItem<"replace">[];
}

Context menu configuration in content editor mode.

Type Declaration

OptionaleditTextAreaContent?: CPDFContextMenuItem<EditTextAreaContentKey>[]
this is the menu options shown when clicking on a text area in content editor mode.
Example
```
editTextAreaContent: menus('properties', 'edit', 'cut', 'copy', 'delete')
```
OptionaleditSelectTextContent?: CPDFContextMenuItem<EditSelectTextContentKey>[]
This is the menu options shown when the text area enters edit mode and text is selected.
Example
```
editSelectTextContent: menus(
  'properties',
  { key: 'opacity', subItems:['25%', '50%', '75%', '100%'] },
  'cut',
  'copy',
  'delete'
)
```
OptionaleditTextContent?: CPDFContextMenuItem<EditTextContentKey>[]
This is the menu options shown when clicking anywhere in the text area edit state.
Example
```
editTextAreaClickContent: menus('select', 'selectAll', 'paste')
```

`Optional`imageAreaContent?: CPDFContextMenuItem<ImageAreaContentKey>[]

This is the menu options shown when clicking on an image in content editor mode.

Example

imageAreaContent: menus(
 'properties',
'rotateLeft',
'rotateRight',
'replace',
'export',
{ key: 'opacity', subItems:['25%', '50%', '75%', '100%'] },
'flipHorizontal',
'flipVertical',
'crop',
'delete',
'copy',
'cut'

OptionalimageCropMode?: CPDFContextMenuItem<ImageCropModeKey>[]
this is the menu options shown when the image enters crop mode.
Example
```
imageCropMode: menus('done', 'cancel')
```
OptionaleditPathContent?: CPDFContextMenuItem<"delete">[]
This is the menu options shown when clicking on a path in content editor mode.
OptionallongPressWithEditTextMode?: CPDFContextMenuItem<LongPressWithEditTextModeKey>[]
Content Editing Mode: Menu options when you long press on a blank area of a PDF in text editing mode.
Example
```
longPressWithEditTextMode: menus('addText', 'paste', 'keepSourceFormatingPaste')
```
OptionallongPressWithEditImageMode?: CPDFContextMenuItem<LongPressWithEditImageModeKey>[]
Content Editing Mode: Menu options when you long press on the blank area of the PDF in the Edit Image mode.
Example
```
longPressWithEditImageMode: menus('addImage', 'paste')
```
OptionallongPressWithAllMode?: CPDFContextMenuItem<LongPressWithAllModeKey>[]
In content editing mode, long press the blank area of the PDF to select the menu option.
Example
```
longPressWithAllMode: menus('paste', 'keepSourceFormatingPaste')
```
OptionalsearchReplace?: CPDFContextMenuItem<"replace">[]
In content editing mode, when performing text search and replacement, a menu option pops up after selecting the searched text.
Example
```
searchReplace: menus('replace')
```

`Optional`formMode

formMode?: {
    textField?: CPDFContextMenuItem<FormPropertiesDeleteKey>[];
    checkBox?: CPDFContextMenuItem<FormPropertiesDeleteKey>[];
    radioButton?: CPDFContextMenuItem<FormPropertiesDeleteKey>[];
    listBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[];
    comboBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[];
    pushButton?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[];
    signatureField?: CPDFContextMenuItem<SignatureFieldKey>[];
}

Type Declaration

OptionaltextField?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]
Form mode, menu options that pop up after the text field form is selected.
Example
```
textFieldContent: menus('properties', 'delete')
```
OptionalcheckBox?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]
Form mode, menu options that pop up after the checkbox form is selected.
Example
```
checkBoxContent: menus('properties', 'delete')
```
OptionalradioButton?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]
Form mode, menu options that pop up after the radio button form is selected.
Example
```
radioButton: menus('properties', 'delete')
```
OptionallistBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]
Form mode, menu options that pop up after the list box form is selected.
Example
```
listBox: menus('options', 'properties', 'delete')
```
OptionalcomboBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]
Form mode, menu options that pop up after the combo box form is selected.
Example
```
comboBox: menus('options', 'properties', 'delete')
```
OptionalpushButton?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]
Form mode, menu options that pop up after the push button form is selected.
Example
```
pushButton: menus('options' , 'properties', 'delete')
```
OptionalsignatureField?: CPDFContextMenuItem<SignatureFieldKey>[]
Form mode, menu options that pop up after the signature field form is selected.
Example
```
signatureField: menus('startToSign', 'delete')
```

Interface CPDFContextMenuConfig

Index

Properties

Properties

OptionalbackgroundColor

OptionalfontSize

Optionalpadding

OptionaliconSize

Optionalglobal

Type Declaration

Optionalscreenshot?: CPDFContextMenuItem<GlobalMenuKey>[]

Example

OptionalviewMode

Type Declaration

OptionaltextSelect?: CPDFContextMenuItem<ViewTextSelectKey>[]

Example

OptionalannotationMode

Type Declaration

OptionaltextSelect?: CPDFContextMenuItem<AnnotationTextSelectKey>[]

Example

OptionallongPressContent?: CPDFContextMenuItem<LongPressContentKey>[]

Example

OptionalmarkupContent?: CPDFContextMenuItem<MarkupContentKey>[]

Example

OptionalsoundContent?: CPDFContextMenuItem<SoundContentKey>[]

Example

OptionalinkContent?: CPDFContextMenuItem<InkContentKey>[]

Example

OptionalshapeContent?: CPDFContextMenuItem<ShapeContentKey>[]

Example

OptionalfreeTextContent?: CPDFContextMenuItem<FreeTextContentKey>[]

Example

OptionalsignStampContent?: CPDFContextMenuItem<SignStampContentKey>[]

Example

OptionalstampContent?: CPDFContextMenuItem<StampContentKey>[]

Example

OptionallinkContent?: CPDFContextMenuItem<LinkContentKey>[]

Example

OptionalcontentEditorMode

Type Declaration

OptionaleditTextAreaContent?: CPDFContextMenuItem<EditTextAreaContentKey>[]

Example

OptionaleditSelectTextContent?: CPDFContextMenuItem<EditSelectTextContentKey>[]

Example

OptionaleditTextContent?: CPDFContextMenuItem<EditTextContentKey>[]

Example

OptionalimageAreaContent?: CPDFContextMenuItem<ImageAreaContentKey>[]

Example

OptionalimageCropMode?: CPDFContextMenuItem<ImageCropModeKey>[]

Example

OptionaleditPathContent?: CPDFContextMenuItem<"delete">[]

OptionallongPressWithEditTextMode?: CPDFContextMenuItem<LongPressWithEditTextModeKey>[]

Example

OptionallongPressWithEditImageMode?: CPDFContextMenuItem<LongPressWithEditImageModeKey>[]

Example

OptionallongPressWithAllMode?: CPDFContextMenuItem<LongPressWithAllModeKey>[]

Example

OptionalsearchReplace?: CPDFContextMenuItem<"replace">[]

Example

OptionalformMode

Type Declaration

OptionaltextField?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]

Example

OptionalcheckBox?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]

Example

OptionalradioButton?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]

Example

OptionallistBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]

Example

OptionalcomboBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]

Example

OptionalpushButton?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]

Example

OptionalsignatureField?: CPDFContextMenuItem<SignatureFieldKey>[]

Example

Settings

On This Page

`Optional`backgroundColor

`Optional`fontSize

`Optional`padding

`Optional`iconSize

`Optional`global

`Optional`screenshot?: CPDFContextMenuItem<GlobalMenuKey>[]

`Optional`viewMode

`Optional`textSelect?: CPDFContextMenuItem<ViewTextSelectKey>[]

`Optional`annotationMode

`Optional`textSelect?: CPDFContextMenuItem<AnnotationTextSelectKey>[]

`Optional`longPressContent?: CPDFContextMenuItem<LongPressContentKey>[]

`Optional`markupContent?: CPDFContextMenuItem<MarkupContentKey>[]

`Optional`soundContent?: CPDFContextMenuItem<SoundContentKey>[]

`Optional`inkContent?: CPDFContextMenuItem<InkContentKey>[]

`Optional`shapeContent?: CPDFContextMenuItem<ShapeContentKey>[]

`Optional`freeTextContent?: CPDFContextMenuItem<FreeTextContentKey>[]

`Optional`signStampContent?: CPDFContextMenuItem<SignStampContentKey>[]

`Optional`stampContent?: CPDFContextMenuItem<StampContentKey>[]

`Optional`linkContent?: CPDFContextMenuItem<LinkContentKey>[]

`Optional`contentEditorMode

`Optional`editTextAreaContent?: CPDFContextMenuItem<EditTextAreaContentKey>[]

`Optional`editSelectTextContent?: CPDFContextMenuItem<EditSelectTextContentKey>[]

`Optional`editTextContent?: CPDFContextMenuItem<EditTextContentKey>[]

`Optional`imageAreaContent?: CPDFContextMenuItem<ImageAreaContentKey>[]

`Optional`imageCropMode?: CPDFContextMenuItem<ImageCropModeKey>[]

`Optional`editPathContent?: CPDFContextMenuItem<"delete">[]

`Optional`longPressWithEditTextMode?: CPDFContextMenuItem<LongPressWithEditTextModeKey>[]

`Optional`longPressWithEditImageMode?: CPDFContextMenuItem<LongPressWithEditImageModeKey>[]

`Optional`longPressWithAllMode?: CPDFContextMenuItem<LongPressWithAllModeKey>[]

`Optional`searchReplace?: CPDFContextMenuItem<"replace">[]

`Optional`formMode

`Optional`textField?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]

`Optional`checkBox?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]

`Optional`radioButton?: CPDFContextMenuItem<FormPropertiesDeleteKey>[]

`Optional`listBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]

`Optional`comboBox?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]

`Optional`pushButton?: CPDFContextMenuItem<FormOptionsPropertiesDeleteKey>[]

`Optional`signatureField?: CPDFContextMenuItem<SignatureFieldKey>[]