mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class InspectorField

    A set of field/property tags used to define how a property should render in a custom inspector

    Inheritance
    Object
    InspectorField
    Implements
    Attribute
    Namespace: Microsoft.MixedReality.Toolkit.Utilities.Editor
    Assembly: cs.temp.dll.dll
    Syntax
    public class InspectorField : Attribute, Attribute

    Properties

    Label

    The label that will be rendered with the property field in the custom inspector

    Declaration
    public string Label { get; set; }
    Property Value
    Type Description
    String

    Label

    The label that will be rendered with the property field in the custom inspector

    Declaration
    public string Label { get; set; }
    Property Value
    Type Description
    String

    Options

    A string list of options for a pop-up list

    Declaration
    public string[] Options { get; set; }
    Property Value
    Type Description
    String[]

    Options

    A string list of options for a pop-up list

    Declaration
    public string[] Options { get; set; }
    Property Value
    Type Description
    String[]

    Tooltip

    A tooltip for the property field

    Declaration
    public string Tooltip { get; set; }
    Property Value
    Type Description
    String

    Tooltip

    A tooltip for the property field

    Declaration
    public string Tooltip { get; set; }
    Property Value
    Type Description
    String

    Type

    The type of field or property value type

    Declaration
    public InspectorField.FieldTypes Type { get; set; }
    Property Value
    Type Description
    InspectorField.FieldTypes

    Type

    The type of field or property value type

    Declaration
    public InspectorField.FieldTypes Type { get; set; }
    Property Value
    Type Description
    InspectorField.FieldTypes

    Value

    An object to hold the actual value

    Declaration
    public UnityEngine.Object Value { get; set; }
    Property Value
    Type Description
    UnityEngine.Object

    Value

    An object to hold the actual value

    Declaration
    public UnityEngine.Object Value { get; set; }
    Property Value
    Type Description
    UnityEngine.Object

    Methods

    FieldToProperty(InspectorField, Object, String)

    Declaration
    public static InspectorPropertySetting FieldToProperty(InspectorField attributes, object fieldValue, string fieldName)
    Parameters
    Type Name Description
    InspectorField attributes
    Object fieldValue
    String fieldName
    Returns
    Type Description
    InspectorPropertySetting

    FieldToProperty(InspectorField, Object, String)

    Declaration
    public static InspectorPropertySetting FieldToProperty(InspectorField attributes, object fieldValue, string fieldName)
    Parameters
    Type Name Description
    InspectorField attributes
    Object fieldValue
    String fieldName
    Returns
    Type Description
    InspectorPropertySetting

    GetSettingValue(List<InspectorPropertySetting>, String)

    Get the propertySettings value

    Declaration
    public static object GetSettingValue(List<InspectorPropertySetting> settings, string name)
    Parameters
    Type Name Description
    List<InspectorPropertySetting> settings
    String name
    Returns
    Type Description
    Object

    GetSettingValue(List<InspectorPropertySetting>, String)

    Get the propertySettings value

    Declaration
    public static object GetSettingValue(List<InspectorPropertySetting> settings, string name)
    Parameters
    Type Name Description
    List<InspectorPropertySetting> settings
    String name
    Returns
    Type Description
    Object

    ReverseLookup(String, String[])

    Get the index from a list of strings using string comparison

    Declaration
    public static int ReverseLookup(string option, string[] options)
    Parameters
    Type Name Description
    String option
    String[] options
    Returns
    Type Description
    Int32

    ReverseLookup(String, String[])

    Get the index from a list of strings using string comparison

    Declaration
    public static int ReverseLookup(string option, string[] options)
    Parameters
    Type Name Description
    String option
    String[] options
    Returns
    Type Description
    Int32

    UpdatePropertySetting(InspectorPropertySetting, Object)

    Set the value of the propertySetting

    Declaration
    public static InspectorPropertySetting UpdatePropertySetting(InspectorPropertySetting setting, object update)
    Parameters
    Type Name Description
    InspectorPropertySetting setting
    Object update
    Returns
    Type Description
    InspectorPropertySetting

    UpdatePropertySetting(InspectorPropertySetting, Object)

    Set the value of the propertySetting

    Declaration
    public static InspectorPropertySetting UpdatePropertySetting(InspectorPropertySetting setting, object update)
    Parameters
    Type Name Description
    InspectorPropertySetting setting
    Object update
    Returns
    Type Description
    InspectorPropertySetting

    Implements

    Attribute
    In This Article
    • Properties
      • Label
      • Label
      • Options
      • Options
      • Tooltip
      • Tooltip
      • Type
      • Type
      • Value
      • Value
    • Methods
      • FieldToProperty(InspectorField, Object, String)
      • FieldToProperty(InspectorField, Object, String)
      • GetSettingValue(List<InspectorPropertySetting>, String)
      • GetSettingValue(List<InspectorPropertySetting>, String)
      • ReverseLookup(String, String[])
      • ReverseLookup(String, String[])
      • UpdatePropertySetting(InspectorPropertySetting, Object)
      • UpdatePropertySetting(InspectorPropertySetting, Object)
    • Implements
    Back to top Generated by DocFX