AnnotationCollection.SetText Method (String, String, Boolean)

Applies To: SQL Server (starting with 2016)

Sets the Annotation, with the specified name, to a specified String value. Can also be used to remove a named annotation if it is set to a null reference.

Namespace:   Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices.Core (in Microsoft.AnalysisServices.Core.dll)

Syntax

public void SetText(
    string name,
    string text,
    bool removeIfNull
)

public:
void SetText(
    String^ name,
    String^ text,
    bool removeIfNull
)

member SetText : 
        name:string *
        text:string *
        removeIfNull:bool -> unit

Public Sub SetText (
    name As String,
    text As String,
    removeIfNull As Boolean
)

Parameters

• name
  Type: System.String

  The name of the Annotation to be added.

• text
  Type: System.String

  The value to be set for the Annotation identified by name.

• removeIfNull
  Type: System.Boolean

  If set to true, removes the Annotation specified in name from the collection if text is set to a null reference (Nothing in Visual Basic); if false, no removal is made.

See Also

SetText Overload
AnnotationCollection Class
Microsoft.AnalysisServices Namespace

Return to top