BaseProperty Class

Definition

Represents a Rule property.

public ref class BaseProperty abstract : System::ComponentModel::ISupportInitialize
[System.Windows.Markup.ContentProperty("Arguments")]
public abstract class BaseProperty : System.ComponentModel.ISupportInitialize
type BaseProperty = class
    interface ISupportInitialize
Public MustInherit Class BaseProperty
Implements ISupportInitialize
Inheritance
BaseProperty
Derived
Attributes
Implements

Remarks

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.

Constructors

BaseProperty()

Parameterless constructor. Required for deserialization from a persisted format.

Properties

Arguments

Gets or sets a list of arguments for this property.

Category

Gets or sets the name of the category to which this property belongs.

ContainingRule

Gets or sets the Rule that contains this BaseProperty.

DataSource

Gets or sets the data source where the current value of this property is stored.

Default

Gets or sets the default value for this property.

Description

Gets or sets a description of this BaseProperty for use by a prospective UI client.

DisplayName

Gets or sets a name that can be used by a prospective UI client to display this BaseProperty.

F1Keyword

Gets or sets the keyword that is used to open the help page for this property.

HelpContext

Gets or sets the Help context to use when the user presses F1.

HelpFile

Gets or sets the Help file to use when the user presses F1.

HelpUrl

Gets or sets the URL of the Help page for this property. The page is opened when the user presses F1.

IncludeInCommandLine

Gets or sets a hint to the command-line constructor whether to include this property in the command line.

IsRequired

Gets or sets a value that indicates whether this property is required to have a value set.

Metadata

Gets or sets additional attributes of this BaseProperty.

MultipleValuesAllowed

Gets or sets a value that indicates whether this property allows multiple values to be supplied/selected simultaneously.

Name

Gets or sets the name of this BaseProperty.

ReadOnly

Gets or sets a value that indicates whether this property is read-only.

Separator

Gets or sets the token used to separate a switch from its value.

Subcategory

Gets or sets the subcategory this property belongs to.

Switch

Gets or sets the switch representation of this property when the property represents a tool parameter.

SwitchPrefix

Gets or sets the prefix for the switch representation of this property when this property represents a tool parameter.

ValueEditors

Gets or sets the list of value editors for this property.

Visible

Gets or sets a hint to the UI client that tells it whether to display this property.

Methods

BeginInit()

See BeginInit().

EndInit()

See EndInit().

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to