BaseProperty Class

Reference

Definition

Namespace:: Microsoft.Build.Framework.XamlTypes

Assembly:: Microsoft.Build.Framework.dll

Package:: Microsoft.Build.Framework v15.9.20

Package:: Microsoft.Build.Framework v16.11.0

Package:: Microsoft.Build.Framework v17.11.4

Source:: BaseProperty.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a Rule property.

public ref class BaseProperty abstract : System::ComponentModel::ISupportInitialize

[System.Windows.Markup.ContentProperty("Arguments")]
public abstract class BaseProperty : System.ComponentModel.ISupportInitialize

[<System.Windows.Markup.ContentProperty("Arguments")>]
type BaseProperty = class
    interface ISupportInitialize

Public MustInherit Class BaseProperty
Implements ISupportInitialize

Inheritance: Object
BaseProperty

Derived: Microsoft.Build.Framework.XamlTypes.BoolProperty

Microsoft.Build.Framework.XamlTypes.DynamicEnumProperty

Microsoft.Build.Framework.XamlTypes.EnumProperty

Microsoft.Build.Framework.XamlTypes.IntProperty

Microsoft.Build.Framework.XamlTypes.StringListProperty

More…

Attributes: ContentPropertyAttribute

Implements: ISupportInitialize

Remarks

This represents schema information (name, allowed values, etc) of a Rule property. Since this is just schema information, there is no field like "Value" used to get/set the value of this property.

Those who manually instantiate this class should remember to call BeginInit() before setting the first property and EndInit() after setting the last property of the object.

Constructors

BaseProperty()

Default constructor. Needed for deserializtion from a persisted format.

Properties

Arguments	List of arguments for this property.
Category	The name of the category to which this property belongs to.
ContainingRule	The Rule containing this BaseProperty.
DataSource	The data source where the current value of this property is stored.
Default	Specifies the default value for this property.
Description	Description of this BaseProperty for use by a prospective UI client.
DisplayName	The name that could be used by a prospective UI client to display this BaseProperty.
F1Keyword	The keyword that is used to open the help page for this property.
HelpContext	The help context to use when the user hits F1. Must specify HelpFile along with this.
HelpFile	The help file to use when the user hits F1. Must specify HelpContext along with this.
HelpUrl	The URL of the help page for this property that will be opened when the user hits F1.
IncludeInCommandLine	A hint to the command line constructor whether to include this property in the command line or not.
IsRequired	Indicates whether this property is required to have a value set.
Metadata	Additional attributes of this BaseProperty.
MultipleValuesAllowed	A value indicating whether this property allows multiple values to be supplied/selected simultaneously.
Name	The name of this BaseProperty.
ReadOnly	Tells if this property is a read-only property.
Separator	The token used to separate a switch from its value.
Subcategory	The sub category to which this property belongs to.
Switch	The switch representation of this property for the case when this property represents a tool parameter.
SwitchPrefix	The prefix for the switch representation of this property for the case when this property represents a tool parameter.
ValueEditors	List of value editors for this property.
Visible	A hint to the UI client telling it whether to display this property or not.

Methods

BeginInit()	See ISupportInitialize.
EndInit()	See ISupportInitialize.

Applies to

Share via