In This Topic ▼

groupsRoles Property

Summary

Gets or sets the AnnGroupsRoles associated with this container.

Syntax

TypeScript

JavaScript

Object.defineProperty(AnnContainer.prototype, 'groupsRoles', 
	get: function(), 
	set: function(value) 
)

groupsRoles: AnnGroupsRoles;

The AnnGroupsRoles object to be associated with this container. Default value is null.

Remarks

The following occurs when the value of GroupsRoles is not null:

The user ID of any annotation object added to this container will be updated if it was empty. This is performed by checking the value of AnnObject.UserId against an empty string or null, and if so, updating this value with AnnGroupsRoles.CurrentUser.
When performing hit-testing, objects that do not have the correct role will be ignored and cannot be hit-tested (and thus, selected by the automation). This is performed by calling AnnGroupsRoles.IsCurrentUserInRole with AnnOperationType.HitTestObjects and either allowing the hit-test or ignoring it if based on the method return value. This is done when HitTestPoint or HitTestRect is called.

Requirements

Help Version 23.0.2024.3.4

Leadtools.Annotations.Engine Assembly