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
[<System.Windows.Markup.ContentProperty("Arguments")>]
type BaseProperty = class
    interface ISupportInitialize
Public MustInherit Class BaseProperty
Implements ISupportInitialize
Inheritance
BaseProperty
Derived
Attributes
Implements

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.

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