StringItem Property

Type

System.String

 

Access

Get/Set

 

Description

The StringItem property provides access to the parameters in the ParameterCollection that hold a string value.  The property takes a single argument, which gives the name of the desired parameter.  If no such parameter exists in the collection, a GeoCalcException will be thrown.

In C#, this property takes the form of two methods:

public System.String get_StringItem(System.String name)

public void set_StringItem(System.String name, System.String value)

These methods provide the same access as described above.

 

Example

[VB]

Private Sub GeoCalcNET_ParameterCollection_StringItem(ByVal pc As GeoCalcNET.ParameterCollection)

If pc.AddStringItem("path") Then

pc.StringItem("path") = "parfiles"

Dim s As String = pc.StringItem("path")

End If

End Sub

 

[C#]

private void GeoCalcNET_ParameterCollection_StringItem(GeoCalcNET.ParameterCollection pc)

{

String stringVal = "Jasper";

String paramName = "Jasper's Name";

if(pc.AddStringItem(paramName))

{

pc.set_StringItem(paramName, stringVal);

String s = pc.get_StringItem(paramName);

}

}