IParameter Interface#

Interface base class of all parameters.

Syntax#

C#

public interface IParameter

VB

Public Interface IParameter

The IParameter type exposes the following members.

Properties#

	Name	Description
	Advanced	The advanced parameter settings, if available.
	FullName	The full name of the parameter including path information.
	IsEmpty	Indicates if the parameter is empty. If true, the parameter is invalid or does not exist. If a requested parameter does not exist in a parameter collection, an empty parameter object will be returned to simplify handling. An empty parameter is never readable or writable.
	IsReadable	Indicates if the parameter is readable.
	IsWritable	Indicates if the parameter is writable.
	Name	The name of the parameter without path information.

Methods#

	Name	Description
	ParseAndSetValue	Parses the value as string and sets the value.
	ToString	The parameter value as a string.

Events#

	Name	Description
	ParameterChanged	This event fires after any of the parameter properties (value, readability, writability, or advanced parameter settings) have changed.
	ParameterValueChanged	This event fires after the parameter value has changed.

IParameter.ParameterChanged Event#

This event fires after any of the parameter properties (value, readability, writability, or advanced parameter settings) have changed.

Syntax#

C#

event EventHandler<ParameterChangedEventArgs> ParameterChanged

VB

Event ParameterChanged As EventHandler(Of ParameterChangedEventArgs)

Value#

Type: System.EventHandler(ParameterChangedEventArgs)

Remarks#

Thread Safety: The firing of the event is synchronized with the source of the parameter collection.

Error Safety: Exceptions from this event will propagate through. The notification of event handlers stops when an exception is triggered.

IParameter.ParameterValueChanged Event#

This event fires after the parameter value has changed.

Syntax#

C#

event EventHandler<ParameterValueChangedEventArgs> ParameterValueChanged

VB

Event ParameterValueChanged As EventHandler(Of ParameterValueChangedEventArgs)

Value#

Type: System.EventHandler(ParameterValueChangedEventArgs)

Remarks#

Thread Safety: The firing of the event is synchronized with the source of the parameter collection.

Error Safety: Exceptions from this event will propagate through. The notification of event handlers stops when an exception is triggered.

IParameter.ParseAndSetValue Method#

Parses the value as string and sets the value.

Syntax#

C#

void ParseAndSetValue(
    string value
)

VB

Sub ParseAndSetValue ( 
    value As String
)

Parameters#

value

Type: System.String
The value as string.

Remarks#

Preconditions:
 

• The parameter must be writable.
• The value must be valid.

Error Safety: Can throw exceptions, e.g. if parsing or writing the value fails.

IParameter.ToString Method#

The parameter value as a string.

Syntax#

C#

string ToString()

VB

Function ToString As String

Return Value#

Type: String
Returns the parameter value as a string. If the value could not be read, one of the following strings are returned: , or

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Does not throw exceptions.

IParameter.Advanced Property#

The advanced parameter settings, if available.

Syntax#

C#

IAdvancedParameterAccess Advanced { get; }

VB

ReadOnly Property Advanced As IAdvancedParameterAccess
    Get

Return Value#

Type: IAdvancedParameterAccess
Returns advanced parameter settings. Returns null if no advanced parameter settings are available.

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Does not throw exceptions.

IParameter.FullName Property#

The full name of the parameter including path information.

Syntax#

C#

string FullName { get; }

VB

ReadOnly Property FullName As String
    Get

Return Value#

Type: String
Returns the full name of the parameter.

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Does not throw exceptions.

IParameter.IsEmpty Property#

Indicates if the parameter is empty. If true, the parameter is invalid or does not exist. If a requested parameter does not exist in a parameter collection, an empty parameter object will be returned to simplify handling. An empty parameter is never readable or writable.

Syntax#

C#

bool IsEmpty { get; }

VB

ReadOnly Property IsEmpty As Boolean
    Get

Property Value#

Type: Boolean

Remarks#

Thread Safety:This method is synchronized with the source of the parameter collection, if any.

Error Safety:Does not throw exceptions.

IParameter.IsReadable Property#

Indicates if the parameter is readable.

Syntax#

C#

bool IsReadable { get; }

VB

ReadOnly Property IsReadable As Boolean
    Get

Return Value#

Type: Boolean
Returns true if the parameter is readable.

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Does not throw exceptions.

IParameter.IsWritable Property#

Indicates if the parameter is writable.

Syntax#

C#

bool IsWritable { get; }

VB

ReadOnly Property IsWritable As Boolean
    Get

Return Value#

Type: Boolean
Returns true if the parameter is writable.

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Does not throw exceptions.

IParameter.Name Property#

The name of the parameter without path information.

Syntax#

C#

string Name { get; }

VB

ReadOnly Property Name As String
    Get

Return Value#

Type: String
Returns the name of the parameter without path information.

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Does not throw exceptions.