Interface ICsMethod

Model definition of a method in c#.

Inherited Members

ICsMember.Security

ICsMember.MemberType

ICsMember.AddBeforeAsync(string, string)

ICsMember.AddBeforeAsync(string)

ICsMember.AddBeforeAsync(string, bool)

ICsMember.AddAfterAsync(string, string)

ICsMember.AddAfterAsync(string)

ICsMember.DeleteAsync(string)

ICsMember.DeleteAsync()

ICsMember.GetSourceLocationAsync(string)

ICsMember.GetSourceLocationAsync()

ICsMember.ReplaceAsync(string, string)

ICsMember.ReplaceAsync(string)

ICsMember.CommentOutSyntaxAsync(string)

ICsMember.GetMemberSyntaxAsync()

ICsModel.ModelType

ICsModel.GetModel<T>(string)

ICsModel.GetModel(string)

ICsAttributes.Attributes

IParent.Parent

ICsGeneric.GenericParameters

ICsGeneric.GenericTypes

IDotNetMethod.HasParameters

IDotNetMethod.IsAbstract

IDotNetMethod.IsVirtual

IDotNetMethod.IsSealed

IDotNetMethod.IsOverride

IDotNetMethod.IsStatic

IDotNetMethod.IsVoid

IDotNetMethod.IsAsync

IDotNetMethod.IsExtension

IDotNetMethod.SyntaxContent

IDotNetMethod.GetBodySyntaxAsync()

IDotNetMethod.GetBodySyntaxListAsync()

IDotNetMethod.GetExpressionSyntaxAsync()

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

IDotNetGeneric.IsGeneric

IDotNetGeneric.HasStrongTypesInGenerics

Namespace: CodeFactory.DotNet.CSharp

Assembly: CodeFactory.DotNet.dll

Syntax

public interface ICsMethod : ICsMember, ICsModel, ICsAttributes, IParent, ICsGeneric, IDotNetMethod, IDotNetMember, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IParent, ILookup, IDotNetGeneric

Properties

MethodType

Determines the type of method that was loaded into this model.

Declaration

CsMethodType MethodType { get; }

Property Value

Type	Description
CsMethodType

Parameters

Enumeration of the parameters that have been assigned to the method. If HasParameters property is set to false this will be null.

Declaration

IReadOnlyList<CsParameter> Parameters { get; }

Property Value

Type	Description
IReadOnlyList<CsParameter>

ReturnType

The type information about the return type assigned to the method. if flag IsVoid is true then the return type will be set to null.

Declaration

CsType ReturnType { get; }

Property Value

Type	Description
CsType

Methods

AddToBeginningBodySyntaxAsync(string, string)

Adds the source code to the beginning of the method body. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

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

Parameters

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

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

AddToBeginningBodySyntaxAsync(string)

Adds the source code to the beginning of the method body. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

Task<CsSource> AddToBeginningBodySyntaxAsync(string sourceCode)

Parameters

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

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

AddToEndBodySyntaxAsync(string, string)

Adds the source code to the end of the method body. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

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

Parameters

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

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

AddToEndBodySyntaxAsync(string)

Adds the source code to the end of the method body. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

Task<CsSource> AddToEndBodySyntaxAsync(string sourceCode)

Parameters

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

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

DeleteBodySyntaxAsync()

Deletes the source syntax from the method body. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

Task<CsSource> DeleteBodySyntaxAsync()

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

DeleteBodySyntaxAsync(string)

Deletes the source syntax from the method body. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

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

Parameters

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

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

ReplaceBodySyntaxAsync(string, string)

Replaces the syntax in the body of the method. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

[Obsolete("No longer support will be removed in later edition, you no longer need to pass the source document.", false)]
Task<CsSource> ReplaceBodySyntaxAsync(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 body of the method.

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

ReplaceBodySyntaxAsync(string)

Replaces the syntax in the body of the method. The ContentSyntax must be set to Body or else an exception will be thrown.

Declaration

Task<CsSource> ReplaceBodySyntaxAsync(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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

ReplaceExpressionAsync(string, string)

Replaces the expression assigned to the method with the provided source code. The ContentSyntax must be set to Expression or else an exception will be thrown.

Declaration

[Obsolete("No longer support will be removed in later edition, you no longer need to pass the source document.", false)]
Task<CsSource> ReplaceExpressionAsync(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 will replace the original expression.

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

ReplaceExpressionAsync(string)

Replaces the expression assigned to the method with the provided source code. The ContentSyntax must be set to Expression or else an exception will be thrown.

Declaration

Task<CsSource> ReplaceExpressionAsync(string sourceCode)

Parameters

Type	Name	Description
string	sourceCode	The source code that will replace the original expression.

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.
CodeFactoryException	Error is raised if the incorrect ContentSyntax is present.

Extension Methods

DocumentationExtensions.CSharpFormatXmlDocumentationEnumerator(IDocumentation)

DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType)

DotNetMemberExtensions.FormatCSharpComparisonHashCode(IDotNetMethod, bool, bool, bool)

DotNetMemberExtensions.FormatCSharpDeclarationSyntax(IDotNetMethod, bool, bool, bool, bool)