ApiMember Class

This is used to contain information about an API member entry in a reflection information file

Definition

Namespace: Sandcastle.Core.Reflection
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0
public class ApiMember
Inheritance
Object    ApiMember

Constructors

ApiMember Constructor

Properties

ApiGroup This read-only property returns the member's API group
ApiSubgroup This read-only property returns the member's API subgroup
ApiSubSubgroup This read-only property returns the member's API sub-subgroup
ApiTopicGroup This read-only property returns the API topic group
ApiTopicSubgroup This read-only property returns the API topic subgroup
ApiTopicSubSubgroup This read-only property returns the API topic subgroup
ChildElements This read-only property returns an enumerable list of child element IDs for those topics that have them
FirstParameterTypeName This read-only property is used to get the type of the first parameter
ImplementedType This read-only property is used to get the type of the member if explicitly implemented
IsExplicitlyImplemented This read-only property returns whether or not the member is an explicit interface member implementation
MemberId This read-only property returns the full API member ID including its prefix
MemberIdWithoutParameters This read-only property returns the API member ID excluding the parameters (methods only)
MemberIdWithoutPrefix This read-only property returns the API member ID excluding the leading prefix
Name This read-only property returns the member name without the namespace or parameters
Node The raw XML for the API entry
OverloadTopicId This read-only property returns the overload topic ID if the member is overloaded
ParameterCount This read-only property is used to get the parameter count for methods
TopicEiiName This read-only property returns the member's topic name for explicit interface implementations
TopicFilename This read-only property returns the topic filename
TopicGroup This read-only property returns the member's topic group
TopicName This read-only property returns the member's topic name
TopicSubgroup This read-only property returns the member's topic subgroup
TopicSubSubgroup This read-only property returns the member's topic sub-subgroup
TypeApiSubgroup This read-only property returns the member's type API subgroup
TypeTopicId This read-only property returns the member's type topic ID

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also