IAnnotationServiceCreateAnnotation(Guid, Guid, AnnotationCreationOptionsWithCoordinates, Task) Method

Creates a textual annotation.

Namespace: Dundas.BI.Data.Annotations
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)

Syntax

C++

Copy

Annotation CreateAnnotation(
	Guid viewId,
	Guid metricSetId,
	AnnotationCreationOptionsWithCoordinates options,
	out Task notificationTask
)

Function CreateAnnotation ( 
	viewId As Guid,
	metricSetId As Guid,
	options As AnnotationCreationOptionsWithCoordinates,
	<OutAttribute> ByRef notificationTask As Task
) As Annotation

Annotation^ CreateAnnotation(
	Guid viewId, 
	Guid metricSetId, 
	AnnotationCreationOptionsWithCoordinates^ options, 
	[OutAttribute] Task^% notificationTask
)

abstract CreateAnnotation : 
        viewId : Guid * 
        metricSetId : Guid * 
        options : AnnotationCreationOptionsWithCoordinates * 
        notificationTask : Task byref -> Annotation

Parameters

viewId Guid: The view ID.
metricSetId Guid: The metric set ID.
options AnnotationCreationOptionsWithCoordinates: The annotation creation options.
notificationTask Task: The notification task for the notifications triggered by the annotation.

Return Value

Annotation
The annotation.

Exceptions

Exception	Condition
ArgumentException	viewId is Empty -or- metricSetId is Empty.
ArgumentNullException	options is .
NotFoundException	The metric set with the specified ID does not exist.
InvalidOperationException	The 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.
InvalidSessionException	The caller context is not associated with a valid session.

Reference

IAnnotationService Interface

CreateAnnotation Overload

Dundas.BI.Data.Annotations Namespace