DataParameter Class

 

Represents a data parameter that is derived from a data source command, or that is passed with a command to a data source.

Namespace:   Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)


public abstract class DataParameter : IVsDataParameter, IVsDataParameterDescriptor

NameDescription
System_CAPS_protmethodDataParameter()

Initializes a new instance of the DataParameter class.

System_CAPS_protmethodDataParameter(Boolean)

Initializes a new instance of the DataParameter class, specifying whether the instance was derived using the DeriveParameters method.

NameDescription
System_CAPS_protpropertyDefaultSize

Gets an integer value specifying the default size for the current parameter type.

System_CAPS_pubpropertyDescriptor

Gets information that describes the data parameter.

System_CAPS_pubpropertyDirection

Gets or sets a DataParameterDirection object specifying the direction of the parameter.

System_CAPS_protpropertyHasDescriptor

Gets a value indicating whether the data parameter exposes its IVsDataParameterDescriptor implementation through the Descriptor property.

System_CAPS_pubpropertyIsDerived

Gets a Boolean value that indicates whether the current parameter was derived from the data source.

System_CAPS_protpropertyIsFixedSize

Gets a Boolean value indicating whether the size for the current parameter type is fixed.

System_CAPS_pubpropertyIsNullable

Gets a Boolean value indicating whether the current parameter can have a null value provided that it is derived.

System_CAPS_pubpropertyIsOptional

Gets a Boolean value indicating whether the current parameter is optional, provided that it is derived.

System_CAPS_pubpropertyName

Gets or sets the string literal name of the current parameter.

System_CAPS_pubpropertySize

Gets or sets an integer value specifying the size of the parameter.

System_CAPS_pubpropertyType

Gets or sets the data source–specific type of the parameter.

System_CAPS_pubpropertyValue

Gets or sets the value of the parameter.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetDirectionCore()

Retrieves the parameter direction.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetIsNullableCore()

Retrieves a Boolean value indicating whether the current parameter can be null.

System_CAPS_protmethodGetIsOptionalCore()

Retrieves a Boolean value indicating whether the parameter is optional.

System_CAPS_protmethodGetNameCore()

Retrieves the name of the parameter.

System_CAPS_protmethodGetSizeCore()

Retrieves an integer value specifying the size of the parameter.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeCore()

Retrieves the data source–specific type of the parameter.

System_CAPS_protmethodGetTypeFrom(Object)

Infers the data source–specific parameter type from a parameter value.

System_CAPS_protmethodGetValueCore()

Retrieves the value of a specified parameter.

System_CAPS_protmethodIsSupportedDirection(DataParameterDirection)

Retrieves a Boolean value indicating whether the specified parameter direction is supported.

System_CAPS_protmethodIsValidType(String)

Retrieves a Boolean value indicating whether the specified data source–specific type is a valid type.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnDirectionChanged()

Called when the Direction property is changed to signal a change in the parameter direction.

System_CAPS_protmethodOnDirectionChanging(DataParameterDirection)

Called when the Direction property is about to change.

System_CAPS_protmethodOnNameChanged()

Called when the Name property has changed.

System_CAPS_protmethodOnNameChanging(String)

Called when the Name property is about to change.

System_CAPS_protmethodOnSizeChanged()

Called when the Size property has changed.

System_CAPS_protmethodOnSizeChanging(Int32)

Called when the Size property is about to change.

System_CAPS_protmethodOnTypeChanged()

Called when the Type property has changed.

System_CAPS_protmethodOnTypeChanging(String)

Called when the Type property is about to change.

System_CAPS_protmethodOnValueChanged()

Called when the Value property has changed.

System_CAPS_protmethodOnValueChanging(Object)

Called when the Value property is about to change.

System_CAPS_pubmethodParse(String)

Disassembles a parameter value in a string format and converts the value to the correct type.

System_CAPS_protmethodSetDirectionCore(DataParameterDirection)

Sets the direction of the parameter by using the DataParameterDirection enumeration.

System_CAPS_protmethodSetNameCore(String)

Sets the name of the parameter.

System_CAPS_protmethodSetSizeCore(Int32)

Sets an integer value specifying the size of the current parameter.

System_CAPS_protmethodSetTypeCore(String)

Sets the data type of the current parameter.

System_CAPS_protmethodSetValueCore(Object)

Sets the value of the parameter.

System_CAPS_pubmethodToString()

Retrieves a string representation of the value of the current parameter.(Overrides Object.ToString().)

System_CAPS_protmethodTryConvertValue(Object, String)

Attempts to convert the specified value to the specified type.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticNullSize

A public size constant holding the value of zero.

This class uses an indirect mechanism for implementing parameter properties. Each property get method calls a virtual protected method that retrieves the property. Each property set method, however, calls three virtual protected methods: one indicating that the property is changing, another actually changing the property, and a third indicating that the property has changed.

This allows the property setter to isolate the handling of invalid input in the property changing method, set the property, and apply any side effects in the property changed method. This also allows the base class to provide some default error checking to match the semantics defined by the parameter interface.

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

Return to top
Show: