s&box docs

public class Sandbox.MemberDescription

Wraps MemberInfo but with caching and sandboxing. Returned by `Sandbox.Internal.TypeLibrary` and `Sandbox.TypeDescription`.

Methods

Showing 9 methods

protected void CaptureAttributes(System.Reflection.MemberInfo member)

public T GetCustomAttribute()

Returns the first of Attributes of the passed in type. Or null.

public Sandbox.DisplayInfo GetDisplayInfo()

Access the full DisplayInfo for this type. This is faster than creating the DisplayInfo every time we need it.

protected virtual int GetIdentityHash()

Generate a unique hash to identity this member.

public bool HasTag(string tag)

Returns true if Tags contains this tag

protected void Init(System.Reflection.MemberInfo x)

public bool IsNamed(string name)

Utility function to check whether this string matches this type. Will search name and classname.

Properties

Showing 21 properties

public string[] Sandbox.MemberDescription.Aliases { get; set; }

Aliases allow this to be found by alternative names.

public Sandbox.TypeDescription Sandbox.MemberDescription.DeclaringType { get; set; }

The type that actually defined this member. This may be different from `Sandbox.MemberDescription.TypeDescription` if this member is inherited from a base class.

public string Sandbox.MemberDescription.Description { get; set; }

Description of this type member. This usually provided from the summary XML comment above the definition.

public string Sandbox.MemberDescription.Group { get; set; }

The group - usually provided via the [Group] attribute

public string Sandbox.MemberDescription.Icon { get; set; }

The icon for this, if provided via the [Icon] attribute

public int Sandbox.MemberDescription.Identity { get; set; }

An integer that represents this member. Based off its type and name.

public virtual bool Sandbox.MemberDescription.IsField { get; set; }

True if we're a field

public virtual bool Sandbox.MemberDescription.IsMethod { get; set; }

True if we're a method

public virtual bool Sandbox.MemberDescription.IsProperty { get; set; }

True if we're a property

public bool Sandbox.MemberDescription.IsPublic { get; set; }

True if publicly accessible

public int Sandbox.MemberDescription.Order { get; set; }

The display order - usually provided via the [Order] attribute

public bool Sandbox.MemberDescription.ReadOnly { get; set; }

If this is marked as [ReadOnly]

public string Sandbox.MemberDescription.SourceFile { get; set; }

The file containing this member

public int Sandbox.MemberDescription.SourceLine { get; set; }

The line number of this member

public string[] Sandbox.MemberDescription.Tags { get; set; }

Tags are usually provided via the [Tags] attribute

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Reflection
Doc IDT:Sandbox.MemberDescription

On this page

Methodsprotected System.Void CaptureAttributes(System.Reflection.MemberInfo member)public T GetCustomAttribute()public Sandbox.DisplayInfo GetDisplayInfo()protected virtual System.Int32 GetIdentityHash()public System.Boolean HasAttribute(System.Type t)public System.Boolean HasAttribute()public System.Boolean HasTag(System.String tag)protected System.Void Init(System.Reflection.MemberInfo x)public System.Boolean IsNamed(System.String name)Propertiespublic System.String[] Sandbox.MemberDescription.Aliases { get; set; }public System.Attribute[] Sandbox.MemberDescription.Attributes { get; set; }public Sandbox.TypeDescription Sandbox.MemberDescription.DeclaringType { get; set; }public System.String Sandbox.MemberDescription.Description { get; set; }public System.String Sandbox.MemberDescription.Group { get; set; }public System.String Sandbox.MemberDescription.Icon { get; set; }public System.Int32 Sandbox.MemberDescription.Identity { get; set; }public System.Boolean Sandbox.MemberDescription.IsFamily { get; set; }public virtual System.Boolean Sandbox.MemberDescription.IsField { get; set; }public virtual System.Boolean Sandbox.MemberDescription.IsMethod { get; set; }public virtual System.Boolean Sandbox.MemberDescription.IsProperty { get; set; }public System.Boolean Sandbox.MemberDescription.IsPublic { get; set; }public System.Boolean Sandbox.MemberDescription.IsStatic { get; set; }public System.String Sandbox.MemberDescription.Name { get; set; }public System.Int32 Sandbox.MemberDescription.Order { get; set; }public System.Boolean Sandbox.MemberDescription.ReadOnly { get; set; }public System.String Sandbox.MemberDescription.SourceFile { get; set; }public System.Int32 Sandbox.MemberDescription.SourceLine { get; set; }public System.String[] Sandbox.MemberDescription.Tags { get; set; }public System.String Sandbox.MemberDescription.Title { get; set; }public Sandbox.TypeDescription Sandbox.MemberDescription.TypeDescription { get; set; }Metadata