Open this page in the API Guide

IAnnotationService.CreateAnnotation Method (Guid, Guid, AnnotationCreationOptionsWithCoordinates)

Creates a textual annotation.

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

Parameters

viewId
Type: System.Guid
The view ID.
metricSetId
Type: System.Guid
The metric set ID.
options
Type: Dundas.BI.Data.Annotations.AnnotationCreationOptionsWithCoordinates
The annotation creation options.

Return Value

Type: Annotation
The annotation.
Exceptions
ExceptionCondition
ArgumentException

viewId is Empty

-or-

metricSetId is Empty.

ArgumentNullExceptionoptions is null.
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