Interface ICsMember

Base definition for all c# member models.

Inherited Members

ICsModel.ModelType

ICsModel.GetModel<T>(string)

ICsModel.GetModel(string)

ICsAttributes.Attributes

IDotNetMember.Name

IDotNetModel.LoadedFromSource

IDotNetModel.Language

IDotNetModel.SourceDocument

IModelStatus.IsLoaded

IModelStatus.HasErrors

IModelStatus.GetErrors()

ISourceFiles.SourceFiles

ISourceFiles.ModelSourceFile

IDotNetAttributes.HasAttributes

IDocumentation.HasDocumentation

IDocumentation.Documentation

IDocumentation.AddBeforeDocsAsync(string)

IDocumentation.AddAfterDocsAsync(string)

IDocumentation.ReplaceDocsAsync(string)

IDocumentation.DeleteDocsAsync()

ILookup.LookupPath

IParent.Parent

Namespace: CodeFactory.DotNet.CSharp

Assembly: CodeFactory.DotNet.dll

Syntax

public interface ICsMember : ICsModel, ICsAttributes, IDotNetMember, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, ILookup, IParent, IParent

Properties

MemberType

The type of member the model is.

Declaration

CsMemberType MemberType { get; }

Property Value

Type	Description
CsMemberType

Security

The security scope that has been assigned to the member.

Declaration

CsSecurity Security { get; }

Property Value

Type	Description
CsSecurity

Methods

AddAfterAsync(string, string)

Adds the source code directly after the definition of the ICsMemberin the target document.

Declaration

[Obsolete("No longer support will be removed in later edition, you no longer need to pass the source document.", false)]
Task<CsSource> AddAfterAsync(string sourceDocument, string sourceCode)

Parameters

Type	Name	Description
string	sourceDocument	The fully qualified path to the source code document to be updated.
string	sourceCode	The source code that is to be added to the document.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the changes have been applied.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

AddAfterAsync(string)

Adds the source code directly after the definition of the ICsMemberin the target document.

Declaration

Task<CsSource> AddAfterAsync(string sourceCode)

Parameters

Type	Name	Description
string	sourceCode	The source code that is to be added to the document.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the changes have been applied.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

AddBeforeAsync(string, bool)

Adds the source code directly before the definition of the ICsMemberin the target document.

Declaration

Task<CsSource> AddBeforeAsync(string sourceCode, bool ignoreLeadingModelsAndDocs)

Parameters

Type	Name	Description
string	sourceCode	The source code that is to be added to the document.
bool	ignoreLeadingModelsAndDocs	Changes the before entry point to the start of the member definition not before the documentation or attributes that are assigned to the member.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the changes have been applied.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

AddBeforeAsync(string, string)

Adds the source code directly before the definition of the ICsMemberin the target document.

Declaration

[Obsolete("No longer support will be removed in later edition, you no longer need to pass the source document.", false)]
Task<CsSource> AddBeforeAsync(string sourceDocument, string sourceCode)

Parameters

Type	Name	Description
string	sourceDocument	The fully qualified path to the source code document to be updated.
string	sourceCode	The source code that is to be added to the document.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the changes have been applied.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

AddBeforeAsync(string)

Adds the source code directly before the definition of the ICsMemberin the target document.

Declaration

Task<CsSource> AddBeforeAsync(string sourceCode)

Parameters

Type	Name	Description
string	sourceCode	The source code that is to be added to the document.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the changes have been applied.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

CommentOutSyntaxAsync(string)

Comments out the member hosting syntax.

Declaration

Task<CsSource> CommentOutSyntaxAsync(string commentSyntax = "//")

Parameters

Type	Name	Description
string	commentSyntax	Optional parameter that sets the syntax used to comment out the member defaults to '//'

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the CsSource model after the member has been commented out. This will return the current instance if the model was not loaded from source.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

DeleteAsync()

Deletes the definition of the member from the source document.

Declaration

Task<CsSource> DeleteAsync()

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the member has been removed from the document.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

DeleteAsync(string)

Deletes the definition of the member from the source document.

Declaration

[Obsolete("No longer support will be removed in later edition, you no longer need to pass the source document.", false)]
Task<CsSource> DeleteAsync(string sourceDocument)

Parameters

Type	Name	Description
string	sourceDocument	The source document that the member is to be removed from.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the member has been removed from the document.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

GetMemberSyntaxAsync()

Gets the syntax that defined the member model.

Declaration

Task<string> GetMemberSyntaxAsync()

Returns

Type	Description
Task<string>	The syntax that makes up the member or null if the syntax cannot be loaded. This will be null if the model was not loaded from source code.

GetSourceLocationAsync()

Gets the starting and ending locations within the document where the member is located.

Declaration

Task<ISourceLocation> GetSourceLocationAsync()

Returns

Type	Description
Task<ISourceLocation>	The source location for the member.

Exceptions

Type	Condition
DocumentException	Raised when an error occurs getting the location from the document.

GetSourceLocationAsync(string)

Gets the starting and ending locations within the document where the member is located.

Declaration

[Obsolete("No longer support will be removed in later edition, you no longer need to pass the source document.", false)]
Task<ISourceLocation> GetSourceLocationAsync(string sourceDocument)

Parameters

Type	Name	Description
string	sourceDocument	The fully qualified path to the document that has the member defined in.

Returns

Type	Description
Task<ISourceLocation>	The source location for the member.

Exceptions

Type	Condition
DocumentException	Raised when an error occurs getting the location from the document.

ReplaceAsync(string, string)

Replaces the current member with the provided source code.

Declaration

[Obsolete("No longer support will be removed in later edition, you no longer need to pass the source document.", false)]
Task<CsSource> ReplaceAsync(string sourceDocument, string sourceCode)

Parameters

Type	Name	Description
string	sourceDocument	The fully qualified path to the source code document to be updated.
string	sourceCode	The source code that is to be used to replace the original definition in the document.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the changes have been applied.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

ReplaceAsync(string)

Replaces the current member with the provided source code.

Declaration

Task<CsSource> ReplaceAsync(string sourceCode)

Parameters

Type	Name	Description
string	sourceCode	The source code that is to be used to replace the original definition in the document.

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the changes have been applied.

Exceptions

Type	Condition
DocumentException	Error is raised when errors occur updating the source document.

Extension Methods

DocumentationExtensions.CSharpFormatXmlDocumentationEnumerator(IDocumentation)

DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType)