AnnotationCollection.SetText Method (String, String, Boolean)

Article
12/03/2008

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 (in microsoft.analysisservices.dll)

Syntax

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

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

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

public void SetText (
    String name, 
    String text, 
    boolean removeIfNull
)

public function SetText (
    name : String, 
    text : String, 
    removeIfNull : boolean
)

Parameters

name
The name of the Annotation to be added.

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

removeIfNull
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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via