IIntegerParameter Interface#

Interface class for integer parameters.

Syntax#

C#

public interface IIntegerParameter : IParameter

VB

Public Interface IIntegerParameter
    Inherits IParameter

The IIntegerParameter type exposes the following members.

Properties#

	Name	Description
	Advanced	The advanced parameter settings, if available. (Inherited from IParameter.)
	FullName	The full name of the parameter including path information. (Inherited from IParameter.)
	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. (Inherited from IParameter.)
	IsReadable	Indicates if the parameter is readable. (Inherited from IParameter.)
	IsWritable	Indicates if the parameter is writable. (Inherited from IParameter.)
	Name	The name of the parameter without path information. (Inherited from IParameter.)

Methods#

	Name	Description
	GetIncrement	Gets the increment value of the current parameter.
	GetMaximum	Gets the maximum value of the current parameter.
	GetMinimum	Gets the minimum value of the current parameter.
	GetValue	Gets the current parameter value.
	ParseAndSetValue	Parses the value as string and sets the value. (Inherited from IParameter.)
	SetValue	Sets the provided value.
	ToString	The parameter value as a string. (Inherited from IParameter.)

Events#

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

Extension Methods#

	Name	Description
	GetValueOrDefault	Gets the parameter value if the parameter is readable. Otherwise, returns the default value. (Defined by IIntegerParameterExtensions.)
	GetValuePercentOfRange	Returns the current value in percent of minimum/maximum range. (Defined by IIntegerParameterExtensions.)
	SetToMaximum	Sets the parameter value to the maximum possible value. (Defined by IIntegerParameterExtensions.)
	SetToMinimum	Sets the parameter value to the minimum possible value. (Defined by IIntegerParameterExtensions.)
	SetValue	Sets the provided value. The value is automatically corrected if needed. (Defined by IIntegerParameterExtensions.)
	SetValuePercentOfRange	Sets the provided value to a value within the range, using this formula (simplified): ((maxRange - minRange) * (percentOfRange / 100.0)) + minRange. The computed value is always corrected to the nearest valid value. (Defined by IIntegerParameterExtensions.)
	TrySetToMaximum	Sets the parameter value to the maximum possible value if the parameter is readable and writable. (Defined by IIntegerParameterExtensions.)
	TrySetToMinimum	Sets the parameter value to the minimum possible value if the parameter is readable and writable. (Defined by IIntegerParameterExtensions.)
	TrySetValue(Int64)	Overloaded. Sets the value passed if the parameter is writable. The value must be in the valid range and the increment must be correct. (Defined by IIntegerParameterExtensions.)
	TrySetValue(Int64, IntegerValueCorrection)	Overloaded. Sets the provided value if the parameter is writable and readable. The value is automatically corrected if needed. (Defined by IIntegerParameterExtensions.)
	TrySetValuePercentOfRange	If the parameter is writable and readable, the provided value in percentage of range (simplified): ((max - min) * (percentOfRange / 100.0)) + min is set. The computed value is always corrected to the nearest valid value. (Defined by IIntegerParameterExtensions.)

IIntegerParameter.GetIncrement Method#

Gets the increment value of the current parameter.

Syntax#

C#

long GetIncrement()

VB

Function GetIncrement As Long

Return Value#

Type: Int64
Returns the increment value of the current parameter.

Remarks#

Preconditions: The parameter must be readable.

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

Error Safety: Can throw exceptions if the parameter is not readable or if reading the value fails.

IIntegerParameter.GetMaximum Method#

Gets the maximum value of the current parameter.

Syntax#

C#

long GetMaximum()

VB

Function GetMaximum As Long

Return Value#

Type: Int64
Returns the maximum value of the current parameter.

Remarks#

Preconditions: The parameter must be readable.

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

Error Safety: Can throw exceptions if the parameter is not readable or if reading the value fails.

IIntegerParameter.GetMinimum Method#

Gets the minimum value of the current parameter.

Syntax#

C#

long GetMinimum()

VB

Function GetMinimum As Long

Return Value#

Type: Int64
Returns the minimum value of the current parameter.

Remarks#

Preconditions: The parameter must be readable.

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

Error Safety: Can throw exceptions if the parameter is not readable or if reading the value fails.

IIntegerParameter.GetValue Method#

Gets the current parameter value.

Syntax#

C#

long GetValue()

VB

Function GetValue As Long

Return Value#

Type: Int64
Returns the current parameter value.

Remarks#

Preconditions: The parameter must be readable.

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

Error Safety: Can throw exceptions if the parameter is not readable or if reading the value fails.

IIntegerParameter.SetValue Method#

Sets the provided value.

Syntax#

C#

void SetValue(
    long value
)

VB

Sub SetValue ( 
    value As Long
)

Parameters#

value: Type: System.Int64
The value to set.

Remarks#

Preconditions:

The parameter must be writable.
The value passed must be >= GetMinimum().
The value passed must be <= GetMaximum().
The value passed must be aligned to the increment returned by GetIncrement().

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

Error Safety: Can throw exceptions if writing the value fails, if the value is out of bounds, if the alignment is not correct, or if the parameter is not writable.