public interface IPropertyData

assembly RefDocGen
namespace RefDocGen.CodeElements.Members.Abstract
Implements:  IValueMemberData, IMemberData, ICallableMemberData
Represents data of a property.

Properties

public AccessModifier AccessModifier { get; } #
Inherited from IMemberData
Access modifier of the member.
public IEnumerable<IMethodData> Accessors { get; } #
Gets the declared accessors (getter and setter) of the property represented as IMethodData objects.
public IReadOnlyList<IAttributeData> Attributes { get; } #
Inherited from IMemberData
Collection of attributes applied to the member.
public ITypeNameData BaseDeclaringType { get; } #
Inherited from ICallableMemberData
If the member overrides another member, this property returns the base type that originally declared the member. null is returned if the member doesn't override anything.
public object ConstantValue { get; } #
Inherited from IValueMemberData
Constant value of the member.
Returns DBNull.Value if the member has no constant value. (note that this is done, because null can be declared as a constant value of the member.
public ITypeDeclaration ContainingType { get; } #
Inherited from IMemberData
Type that contains the member.
Note that for inherited members, this property returns child type (not the original type that declares the member).
public IEnumerable<IExceptionDocumentation> DocumentedExceptions { get; } #
Inherited from ICallableMemberData
Represents a collection of exceptions documented for the member.
Remarks
This collection includes only the exceptions explicitly documented using the exception XML tag. It does not include all possible exceptions that might occur during execution.
public XElement ExampleDocComment { get; } #
Inherited from IMemberData
'example' doc comment provided for the member.
public ITypeNameData ExplicitInterfaceType { get; } #
Inherited from ICallableMemberData
Type of the interface that explicitly declares the member.
null, if the member is not explicitly declared.
Remarks
public IMethodData Getter { get; } #
Getter method represented as a IMethodData object, or null if no getter exists.
public Nullable<AccessModifier> GetterAccessModifier { get; } #
Gets the access modifier of the getter, or null if no getter exists.
public string Id { get; } #
Inherited from IMemberData
Identifier of the member in the same format as in the XML documentation comments file. Consists of the member name (without namespace and type name) and parameters string (if the member has them - e.g. a method).
Uniquely identifies the member within a type.
Remarks
public IEnumerable<ITypeNameData> ImplementedInterfaces { get; } #
Inherited from ICallableMemberData
Returns the interface types, whose part of contract is implemented by this member. Note that explicitly implemented interfaces are not included (see ICallableMemberData.ExplicitInterfaceType).
public ITypeNameData InheritedFrom { get; } #
Inherited from IMemberData
If the member is inherited, this represents the type from which it originates. null if the member is not inherited.
public bool IsAbstract { get; } #
Inherited from ICallableMemberData
Checks whether the member is abstract.
public bool IsAsync { get; } #
Inherited from ICallableMemberData
Checks whether the member is asynchronous.
public bool IsConstant { get; } #
Inherited from IValueMemberData
Checks if the member is a compile-time constant.
public bool IsExplicitImplementation { get; } #
Inherited from ICallableMemberData
Checks if the member is an explicitely impletemented member of an interface.
public bool IsFinal { get; } #
Inherited from ICallableMemberData
Checks whether the member is final.
For further information, see https://learn.microsoft.com/en-us/dotnet/api/system.reflection.methodbase.isfinal
public bool IsInherited { get; } #
Inherited from IMemberData
Indicates whether the member is inhertied from another type.
public bool IsOverridable { get; } #
Inherited from ICallableMemberData
Checks whether the member can be overridden.
True for virtual non-final methods
public bool IsReadonly { get; } #
Inherited from IValueMemberData
Checks if the member is readonly (i.e. can be set just inside a constructor)
public bool IsRequired { get; } #
Inherited from IValueMemberData
Checks if the member is required (i.e. must be initialized by an object initializer).
Remarks
public bool IsSealed { get; } #
Inherited from ICallableMemberData
Checks whether the member is sealed, i.e. virtual that cannot be further overriden.
public bool IsSetterInitOnly { get; } #
Indicates whether the IPropertyData.Setter is only for initialization.
Remarks
If the IPropertyData.Setter is null, false is returned.
public bool IsStatic { get; } #
Inherited from IMemberData
Checks whether the member is static.
public bool IsVirtual { get; } #
Inherited from ICallableMemberData
Checks whether the member is virtual.
True for virtual and abstract members.
public MemberInfo MemberInfo { get; } #
Inherited from IMemberData
MemberInfo object representing the member.
public string Name { get; } #
Inherited from IMemberData
Name of the member.
public bool OverridesAnotherMember { get; } #
Inherited from ICallableMemberData
Checks whether the member overrides another member.
public PropertyInfo PropertyInfo { get; } #
Gets the PropertyInfo object representing the property.
public XElement RemarksDocComment { get; } #
Inherited from IMemberData
'remarks' doc comment for the member.
public IEnumerable<XElement> SeeAlsoDocComments { get; } #
Inherited from IMemberData
Collection of 'seealso' doc comments for the member.
public IMethodData Setter { get; } #
Setter method represented as a IMethodData object, or null if no setter exists.
public Nullable<AccessModifier> SetterAccessModifier { get; } #
Gets the access modifier of the setter, or null if no setter exists.
public XElement SummaryDocComment { get; } #
Inherited from IMemberData
'summary' doc comment for the member.
public ITypeNameData Type { get; } #
Inherited from IValueMemberData
Type of the member.
public XElement ValueDocComment { get; } #
'value' doc comment for the property.