All docs
V20.2
20.2
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.

IRangePermissionSearchOptions Interface

Declares options used to search range permissions by the find(options) method.

Declaration

export interface IRangePermissionSearchOptions

Properties

group Property

Specifies a group of users whose permissions are searched.

Declaration

group?: string | RegExp

Property Value

Type Description
string

The name of the group.

RegExp

A regular expression.

Remarks

var everyoneRangePermissions = richEdit.document.rangePermissions.find({group: 'everyone'});

position Property

Specifies the document position, interval, or array of intervals in which to search for range permissions.

Declaration

position?: number | IInterval | IInterval[]

Property Value

Type Description
number

The document position.

IInterval

The text interval.

IInterval[]

An array of text intervals.

Remarks

var currentPositionRangePermissions = richEdit.document.rangePermissions.find({position: richEdit.selection.active});

userName Property

Specifies the name of the user whose permissions are searched.

Declaration

userName?: string | RegExp

Property Value

Type Description
string

The name of the user.

RegExp

A regular expression.

Remarks

var lawyerRangePermissions = richEdit.document.rangePermissions.find({userName: 'lawyer@somecompany.com'});