Class HelpAttribute

A PropertyAttribute for showing a collapsible Help section.

Inheritance

Object

HelpAttribute

Namespace: Microsoft.MixedReality.Toolkit

Assembly: cs.temp.dll.dll

Syntax

[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
public class HelpAttribute : PropertyAttribute

Constructors

HelpAttribute(String, String, Boolean)

Constructor

Declaration

public HelpAttribute(string helpText, string helpHeader = "Help", bool collapsible = true)

Parameters

Type	Name	Description
String	helpText	The help text to display
String	helpHeader	The help header foldout text
Boolean	collapsible	If true, this help drawer will be collapsible

Fields

Collapsible

If true, this will be a collapsible help section. Defaults to true.

Declaration

public bool Collapsible

Field Value

Type	Description
Boolean

Header

The help header foldout text

Declaration

public string Header

Field Value

Type	Description
String

Remarks

If Collapsible is false, then this header text will not be shown.

Text

The help text

Declaration

public string Text

Field Value

Type	Description
String