struct DisplayInfo

in global :: Sandbox

Collects all the relevant info (such as description, name, icon, etc) from attributes and other sources about a type or type member.

public string ClassName

"Internal" class name of this type or member. This typically should be all lowercase and without weird symbols or whitespace.

public string Namespace

Namespace of this type

public string Fullname

Namespace.ParentClass.Class.Member

public string Name

The name of this type or member.

public string Description

The summary or description of this type or member.

public string Group

Group or category of this type or member. ()

public bool ReadOnly

This is marked as ReadOnly

public string Icon

Material icon of this type or member. ()

public int Order

Order of this member for UI ordering purposes. ()

public bool Browsable

Whether this member should be visible in a properties sheet ()

public string Placeholder

Placeholder text for string type properties. () Placeholder text is displayed in UI when input text field is empty.

public string[] Alias

Possible aliases for this type or member, if any. ()

public string[] Tags

Tags of this type or member. ()

public bool HasTag( string t )

Returns whether this type or member has given tag. ()

  • t The tag to test.
  • Returns Whether the tag is present or not

public static DisplayInfo ForType( Type t, bool inherit = True )

Retrieves display info about a given type.

  • t The type to look up display info for.
  • inherit Whether to load in base type's display info first, then overrides all possible fields with given type's information.
  • Returns The display info. Will contain empty fields on failure.

public static DisplayInfo For( object t, bool inherit = True )

Retrieves display info about a given objects type.

  • t The type to look up display info for.
  • inherit Whether to load in base type's display info first, then overrides all possible fields with given type's information.
  • Returns The display info. Will contain empty fields on failure.

public static DisplayInfo ForMember( MemberInfo t, bool inherit = True )

Retrieves display info about a given member or type.

  • t The member to look up display info for.
  • inherit If member given is a , loads in base type's display info first, then overrides all possible fields with given type's information.
  • Returns The display info. Will contain empty fields on failure.

public static DisplayInfo[] ForEnumValues( Type t )

Returns display info for each member of an enumeration type.

public string ToString( )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public static ValueTuple<T,DisplayInfo>[] ForEnumValues( )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.