MemberDescriptionclass
Wraps MemberInfo but with caching and sandboxing. Returned by `Sandbox.Internal.TypeLibrary` and `Sandbox.TypeDescription`.
Methods9
Showing 9 methods
protected void CaptureAttributes(System.Reflection.MemberInfo member)
| Parameter | Type | Description |
|---|---|---|
| member | MemberInfo | — |
void—public T GetCustomAttribute()
Returns the first of Attributes of the passed in type. Or null.
T—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.
int—public bool HasTag(string tag)
Returns true if Tags contains this tag
| Parameter | Type | Description |
|---|---|---|
| tag | string | — |
bool—protected void Init(System.Reflection.MemberInfo x)
| Parameter | Type | Description |
|---|---|---|
| x | MemberInfo | — |
void—public bool IsNamed(string name)
Utility function to check whether this string matches this type. Will search name and classname.
| Parameter | Type | Description |
|---|---|---|
| name | string | — |
bool—No results match this filter.
Properties21
Showing 21 properties
public string[] Sandbox.MemberDescription.Aliases { get; set; }
Aliases allow this to be found by alternative names.
string[]—public System.Attribute[] Sandbox.MemberDescription.Attributes { get; set; }
Attributes on this member
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.
string—public string Sandbox.MemberDescription.Group { get; set; }
The group - usually provided via the [Group] attribute
string—public string Sandbox.MemberDescription.Icon { get; set; }
The icon for this, if provided via the [Icon] attribute
string—public int Sandbox.MemberDescription.Identity { get; set; }
An integer that represents this member. Based off its type and name.
int—public bool Sandbox.MemberDescription.IsFamily { get; set; }
bool—public virtual bool Sandbox.MemberDescription.IsField { get; set; }
True if we're a field
bool—public virtual bool Sandbox.MemberDescription.IsMethod { get; set; }
True if we're a method
bool—public virtual bool Sandbox.MemberDescription.IsProperty { get; set; }
True if we're a property
bool—public bool Sandbox.MemberDescription.IsPublic { get; set; }
True if publicly accessible
bool—public bool Sandbox.MemberDescription.IsStatic { get; set; }
True if static
bool—public string Sandbox.MemberDescription.Name { get; set; }
Name of this type member.
string—public int Sandbox.MemberDescription.Order { get; set; }
The display order - usually provided via the [Order] attribute
int—public bool Sandbox.MemberDescription.ReadOnly { get; set; }
If this is marked as [ReadOnly]
bool—public string Sandbox.MemberDescription.SourceFile { get; set; }
The file containing this member
string—public int Sandbox.MemberDescription.SourceLine { get; set; }
The line number of this member
int—public string[] Sandbox.MemberDescription.Tags { get; set; }
Tags are usually provided via the [Tags] attribute
string[]—public string Sandbox.MemberDescription.Title { get; set; }
Display name or title of this type member.
string—public Sandbox.TypeDescription Sandbox.MemberDescription.TypeDescription { get; set; }
The type that we're a member of
No results match this filter.