This documentation is archived and is not being maintained.

BaseProperty Class

Represents a Rule property.

Namespace:  Microsoft.Build.Framework.XamlTypes
Assembly:  Microsoft.Build.Framework (in Microsoft.Build.Framework.dll)

public abstract class BaseProperty : ISupportInitialize

The BaseProperty type exposes the following members.

Protected methodBasePropertyDefault constructor. Required for deserializtion from a persisted format.

Public propertyArgumentsGets or sets a list of arguments for this property.
Public propertyCategoryGets or sets the name of the category to which this property belongs.
Public propertyContainingRuleGets or sets the Rule that contains this BaseProperty.
Public propertyDataSourceGets or sets the data source where the current value of this property is stored.
Public propertyDefaultGets or sets the default value for this property.
Public propertyDescriptionGets or sets a description of this BaseProperty for use by a prospective UI client.
Public propertyDisplayNameGets or sets a name that can be used by a prospective UI client to display this BaseProperty.
Public propertyF1KeywordGets or sets the keyword that is used to open the help page for this property.
Public propertyHelpContextGets or sets the Help context to use when the user presses F1.
Public propertyHelpFileGets or sets the Help file to use when the user presses F1.
Public propertyHelpUrlGets or sets the URL of the Help page for this property. The page is opened when the user presses F1.
Public propertyIncludeInCommandLineGets or sets a hint to the command-line constructor whether to include this property in the command line.
Public propertyIsRequiredGets or sets a flag that indicates whether this property is required to have a value set.
Public propertyMetadataGets or sets additional attributes of this BaseProperty.
Public propertyMultipleValuesAllowedGets or sets a switch that specifies whether this property allows multiple values to be supplied/selected simultaneously.
Public propertyNameGets or sets the name of this BaseProperty.
Public propertyReadOnlyGets or sets a flag that indicates whether this property is read-only.
Public propertySeparatorGets or sets the token used to separate a switch from its value.
Public propertySubcategoryGets or sets the subcategory this property belongs to.
Public propertySwitchGets or sets the switch representation of this property when the property represents a tool parameter.
Public propertySwitchPrefixGets or sets the prefix for the switch representation of this property when this property represents a tool parameter.
Public propertyValueEditorsGets or sets the list of value editors for this property.
Public propertyVisibleGets or sets a hint to the UI client that tells it whether to display this property.

Public methodBeginInitSee BeginInit.
Public methodEndInitSee EndInit.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This represents the schema information (name, allowed values, and so on) of a Rule property. Because this is just schema information, there is no field such as "Value" to get/set the value of this property. If you manually instantiate this class, call BeginInit before you set the first property of the object and EndInit after you set the last property.

.NET Framework

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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