Partager via


ParameterOutProperty Class

The ParameterOutProperty class provides descriptive information about a parameter in a parameter list to the ParametersOutProviderInit event of the IParametersOutProvider interface.

System.Object

   Microsoft.SharePoint.WebPartPages.Communication.ParameterOutProperty

Public Constructors

The following table shows the constructors of the ParameterOutProperty class and a brief description of each.

Name Description
ParameterOutProperty Initializes a new instance of the ParameterOutProperty class.

Public Properties

The following table shows the properties of the ParameterOutProperty class, the data type of each property, and a brief description of each.

Name Data type Description
Description String An explanation for the parameter.
ParameterDisplayName String Display name for the parameter. This is an optional value.
ParameterName String Identifier for the parameter, such as BackgroundColor. This should be unique.

Thread Safety

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

Example

The following code example shows an overridden PartCommunicationInit method that creates an instance of the ParameterOutProperty class to define the parameters that will be passed in the ParametersOutProviderInitEventArgs object when the ParametersOutProviderInit event occurs. This code example is part of a larger example provided for the IParametersOutProvider interface.

Requirements

Namespace: Microsoft.SharePoint.WebPartPages.Communication

Platforms: Microsoft Windows Server 2003

Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)

Security: Code Access Security. In addition, the WebPartPermissions.Connections permission is required to use this member.