Setting.ObjectArray Class

Definition

Namespace:

Microsoft.VisualStudio.Extensibility.Settings

Assembly:

Microsoft.VisualStudio.Extensibility.Contracts.dll

Package:

Microsoft.VisualStudio.Extensibility.Contracts v17.12.2051

Configuration of a VisualStudio.Extensibility setting accepting multiple values, each grouping multiple settings.

[System.Runtime.Serialization.DataContract]
public sealed class Setting.ObjectArray : Microsoft.VisualStudio.Extensibility.Settings.ArraySetting<Microsoft.VisualStudio.Extensibility.Settings.ArraySettingItem>, IEquatable<Microsoft.VisualStudio.Extensibility.Settings.Setting.ObjectArray>

[<System.Runtime.Serialization.DataContract>]
type Setting.ObjectArray = class
    inherit ArraySetting<ArraySettingItem>
    interface IEquatable<Setting.ObjectArray>

Public NotInheritable Class Setting.ObjectArray
Inherits ArraySetting(Of ArraySettingItem)
Implements IEquatable(Of Setting.ObjectArray)

Inheritance

Object

Setting

Setting<T[]>

ArraySetting<ArraySettingItem>

Setting.ObjectArray

Attributes

DataContractAttribute

Implements

IEquatable<Setting.ObjectArray>

Constructors

Setting.ObjectArray(String, String, SettingCategory, ArraySettingItemProperty[], ArraySettingItem[])

Initializes a new instance of the Setting.ObjectArray class.

Properties

AllowAdditionsAndRemovals	Gets a value indicating whether the user is able to add and remove items in the UI. The default value of this property is true. (Inherited from ArraySetting<T>)
AllowItemEditing	Gets a value indicating whether the items are editable in the UI. The default value of this property is true. (Inherited from ArraySetting<T>)
DefaultValue	Gets the default value of the setting. (Inherited from Setting<T>)
Description	Gets the verbose description of the setting. (Inherited from Setting)
DisplayName	Gets the display name of the setting. (Inherited from Setting)
EnabledWhen	Gets the rule that determines if this setting is enabled in the UI. (Inherited from Setting)
EnvironmentVariableDefault	Gets the environment variable from which the default value is parsed. If it is not defined or cannot be parsed, the value specified in DefaultValue is used instead. (Inherited from Setting)
FullId	Gets the full id of the setting. (Inherited from Setting<T>)
HasUserSelectableDefaultItem	Gets a value indicating whether this array supports a default item that can be selected by the user.
HelpUri	Gets the URI of a help page. (Inherited from Setting)
Id	Gets the identifier of the setting. (Inherited from Setting)
ItemProperties	Gets the list of ArraySettingItemProperty of the objects in this array.
ItemsAreOrdered	Gets a value indicating whether the items are ordered. (Inherited from ArraySetting<T>)
MaxArrayLength	Gets the maximum string length. (Inherited from ArraySetting<T>)
Messages	Gets a list of messages shown next to the setting in the UI. (Inherited from Setting)
MinArrayLength	Gets the minimum string length. (Inherited from ArraySetting<T>)
ParentCategory	Gets the parent category. (Inherited from Setting)
SearchKeywords	Gets a list of keywords to associate with this setting. When searching using the Visual Studio UI, words in DisplayName, Description, and SearchKeywords can be used to find a setting. (Inherited from Setting)
Tags	Gets a list of tags to associate with the registration. Used when filtering the settings window. (Inherited from Setting)
Type	Gets type identifier of the setting. (Inherited from ArraySetting<T>)
UnsupportedMessage	Gets the message to display if the setting is not supported. (Inherited from Setting)
VisibleWhen	Gets the rule that determines if this setting is visible in the UI. (Inherited from Setting)

Methods

Equals(ArraySetting<T>)	(Inherited from ArraySetting<T>)
Equals(Object)
Equals(Setting)	(Inherited from Setting)
Equals(Setting+ObjectArray)	Indicates whether the current object is equal to another object of the same type.
Equals(Setting<T>)	(Inherited from Setting<T>)
GetHashCode()	Serves as the default hash function.