M

Parameter.Set

Description:
Sets the parameter to a new string of text.

Remarks:
You should only use this method if the StorageType property reports the type of the parameter as a String.

Overloads (4):

Set

Set(Double)

Set(ElementId)

Set(Int32)

Set(String)

public bool Set(
	string value
)

Public Function Set ( 
	value As String
) As Boolean

public:
bool Set(
	String^ value
)

member Set : 
        value : string -> bool

String

value

The new text value to which the parameter is to be set.

Return Value Boolean The Set method will return True if the parameter was successfully set to the new value, otherwise false.

void AddInstanceComment(Wall wall)
{
    // Get the comment parameter of the element instance
    Parameter commentPara = wall.get_Parameter(BuiltInParameter.ALL_MODEL_INSTANCE_COMMENTS);
    if (null != commentPara)
    {
        // Add a greeting string to the comment
        commentPara.Set("Hello Everyone.");
    }
}

Private Sub AddInstanceComment(wall As Wall)
    ' Get the comment parameter of the element instance
    Dim commentPara As Parameter = wall.Parameter(BuiltInParameter.ALL_MODEL_INSTANCE_COMMENTS)
    If commentPara IsNot Nothing Then
        ' Add a greeting string to the comment
        commentPara.[Set]("Hello Everyone.")
    End If
End Sub

InvalidOperationException

The parameter is read-only.