IAnnotationServiceCreateAnnotation Method (Guid, Guid, AnnotationCreationOptionsWithCoordinates, Task)

Creates a textual annotation.

Namespace:  Dundas.BI.Data.Annotations
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
Copy
Annotation CreateAnnotation(
	Guid viewId,
	Guid metricSetId,
	AnnotationCreationOptionsWithCoordinates options,
	out Task notificationTask
)

Parameters

viewId
Type: SystemGuid
The view ID.
metricSetId
Type: SystemGuid
The metric set ID.
options
Type: Dundas.BI.Data.AnnotationsAnnotationCreationOptionsWithCoordinates
The annotation creation options.
notificationTask
Type: System.Threading.TasksTask
The notification task for the notifications triggered by the annotation.

Return Value

Type: Annotation
The annotation.
Exceptions
ExceptionCondition
ArgumentException

viewId is Empty

-or-

metricSetId is Empty.

ArgumentNullExceptionoptions is .
NotFoundExceptionThe metric set with the specified ID does not exist.
InvalidOperationExceptionThe specified metric set is inactive.
NoPrivilegeException

The caller does not have the Read privilege on the specified metric set.

-or-

The caller does not have the Execute privilege on the underlying analysis structure.

-or-

The caller does not have the Note privilege.

InvalidSessionExceptionThe caller context is not associated with a valid session.
See Also