FSlideObjectPermission

Command-backed Edit permission for one stable Slide, Element, or Master object.

Access

Access through:

• FPageElement.getPermission()
• FSlide.getPermission()
• FSlide.getElementPermission()
• FPresentation.getMasterViewPermission()
• FPresentation.getMasterElementPermission()

Setup

Register @univerjs-pro/slides or a preset that includes it. In plugin mode, import @univerjs-pro/slides/facade. Additional methods below require their listed plugin packages. See Facade setup.

@univerjs-pro/slides

FSlideObjectPermission.canEdit

Returns the effective Edit result after applying the Presentation, parent, and object permissions.

canEdit(): boolean

Returns

Whether the object is currently editable.

Package: @univerjs-pro/slides · Type definitions

FSlideObjectPermission.setEditable

Enables or disables editing for this Slide, Element, or Master object.

canEdit() also applies the Presentation and parent object ceilings.

setEditable(editable?: boolean): Promise<void>

Parameters

• editable — Optional. Default: true. Whether object editing is allowed. Defaults to true.

Returns

Resolves after the permission command finishes.

Examples

const presentation = univerAPI.getActivePresentation()const slide = presentation?.getSlideByIndex(0)if (!slide) throw new Error('Slide not found.')await slide.getPermission().setEditable()

Types: Promise

Package: @univerjs-pro/slides · Type definitions

FSlideObjectPermission.setReadOnly

Makes this Slide, Element, or Master object read-only.

setReadOnly(): Promise<void>

Returns

Resolves after the permission command finishes.

Types: Promise

Package: @univerjs-pro/slides · Type definitions