The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body.
The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body. This will return each line of code that has a line feed or return as a separate string.
+
+
+
Declaration
+
+
public abstract Task<List<string>> GetBodySyntaxListAsync()
Gets the expression that has been assigned to the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Expression.
+
+
+
Declaration
+
+
public abstract Task<string> GetExpressionSyntaxAsync()
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
+
+
public abstract Task<CsSource> ReplaceExpressionAsync(string sourceCode)
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
+
+
public abstract Task<CsSource> ReplaceExpressionAsync(string sourceDocument, string sourceCode)
Keyword that is used a validation condition in switch statements. (Note: Available in C# 7.0 and later). Also used as a validation condition with catch statements. (Note: Available in C# 6.0 and later).
Keyword used to start the definition of constraining condition on a generic type. Also used a evaluation to determine what data will be returned from a LINQ expression.
Keyword used in 4 cases, generic type parameters , a parameter modifer to pass arguments, define the target value in for each statements, usage in from clauses, and in join clauses.
Keyword that signals that a passed parameter will receive an output of data. Also used with generic definitions to note the type parameter is covariant.
Security scope that allows access only within the containing class or types that derive from the containing class. (Note: Only in version 7.2 or later of the C# language)
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.
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.
The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code.
+
The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body.
The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body. This will return each line of code that has a line feed or return as a separate string.
Gets the expression that has been assigned to the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Expression.
diff --git a/docs/index.json b/docs/index.json
index 560d1ed..0611bef 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -157,7 +157,7 @@
"api/CodeFactory.DotNet.CSharp.CsMethod.html": {
"href": "api/CodeFactory.DotNet.CSharp.CsMethod.html",
"title": "Class CsMethod | CodeFactory Guidance",
- "keywords": "Class CsMethod Data model that represents a method definition. Inheritance Object CsModel CsMember CsMethod Implements ICsMethod ICsMember ICsModel ICsAttributes IParent ICsGeneric IDotNetMethod IDotNetMember IDotNetModel IModelStatus ISourceFiles IDotNetAttributes IDocumentation IParent ILookup IDotNetGeneric Inherited Members CsMember.HasAttributes CsMember.Attributes CsMember.IDotNetAttributes.Attributes CsMember.SourceFiles CsMember.HasDocumentation CsMember.Documentation CsMember.IParent.Parent CsMember.LookupPath CsMember.Name CsMember.Security CsMember.MemberType CsMember.AddBeforeAsync(String, String) CsMember.AddBeforeAsync(String) CsMember.AddAfterAsync(String, String) CsMember.AddAfterAsync(String) CsMember.DeleteAsync(String) CsMember.DeleteAsync() CsMember.GetSourceLocationAsync(String) CsMember.GetSourceLocationAsync() CsMember.ReplaceAsync(String, String) CsMember.ReplaceAsync(String) CsMember.GetModel(String) CsMember.IDotNetMember.Security CsMember.IDotNetMember.MemberType CsMember.Parent CsModel.LocalModelErrors CsModel.ModelStore CsModel.IsLoaded CsModel.HasErrors CsModel.GetErrors() CsModel.LoadedFromSource CsModel.Language CsModel.ModelType CsModel.SourceDocument CsModel.IDotNetModel.ModelType CsModel.LookupModel(String) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : CodeFactory.DotNet.CSharp Assembly : CodeFactory.DotNet.dll Syntax public abstract class CsMethod : CsMember, ICsMethod, ICsMember, ICsModel, ICsAttributes, IParent, ICsGeneric, IDotNetMethod, IDotNetMember, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IParent, ILookup, IDotNetGeneric Constructors | Improve this Doc View Source CsMethod(Boolean, Boolean, Boolean, SourceCodeType, IReadOnlyList, IReadOnlyList, Boolean, String, String, String, String, CsSecurity, Boolean, Boolean, IReadOnlyList, IReadOnlyList, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, CsMethodType, CsType, IReadOnlyList, String, ModelStore, IReadOnlyList) Constructor for the CsMethod Declaration protected CsMethod(bool isLoaded, bool hasErrors, bool loadedFromSource, SourceCodeType language, IReadOnlyList attributes, IReadOnlyList sourceFiles, bool hasDocumentation, string documentation, string lookupPath, string name, string parentPath, CsSecurity security, bool isGeneric, bool hasStrongTypesInGenerics, IReadOnlyList genericParameters, IReadOnlyList genericTypes, bool hasParameters, bool isAbstract, bool isVirtual, bool isSealed, bool isOverride, bool isStatic, bool isVoid, bool isAsync, bool isExtension, CsMethodType methodType, CsType returnType, IReadOnlyList parameters, string sourceDocument = null, ModelStore modelStore = null, IReadOnlyList modelErrors = null) Parameters Type Name Description Boolean isLoaded Flag that determines if the model was loaded. Boolean hasErrors Flag that determine if errors were found creating the model. Boolean loadedFromSource Flag that determines if the model was loaded from source code or from an existing library. SourceCodeType language The target language the model was generated from. IReadOnlyList < CsAttribute > attributes List of the attributes assigned to this model. IReadOnlyList < String > sourceFiles List of the fully qualified paths to the source code files this member is defined in. Boolean hasDocumentation Flag that determines if the model has XML documentation assigned to it. String documentation The xml documentation assigned to the model. String lookupPath The fully qualified model lookup path for this model. String name The name of the model. String parentPath THe fully qualified lookup path for the parent model to this one. CsSecurity security The security scope assigned to this model. Boolean isGeneric Flag that determines if the method is a generic definition. Boolean hasStrongTypesInGenerics Flag that determines if the generics use strong type definitions. IReadOnlyList < CsGenericParameter > genericParameters Generic parameters assigned to the method. IReadOnlyList < CsType > genericTypes Target types for the generic parameters assigned to the method. Boolean hasParameters Flag that determines if the method had parameters. Boolean isAbstract Flag that determines if the model is abstract. Boolean isVirtual Flag that determines if the model is virtual. Boolean isSealed Flag that determines if the model is sealed. Boolean isOverride Flag that determines if the model is overridden. Boolean isStatic Flag that determines if the model is static. Boolean isVoid Flag that determines if the return type is void. Boolean isAsync Flag that determines if the method has the async keyword assigned. Boolean isExtension Flag that determines if the method is an extension method. CsMethodType methodType The type of method that was implemented. CsType returnType The type definition for the return type. IReadOnlyList < CsParameter > parameters The parameters assigned to the method. String sourceDocument The source document that was used to build this model. This is optional parameter and can be null. ModelStore < ICsModel > modelStore Optional the lookup storage for models created during the compile or lookup of the model. IReadOnlyList < ModelLoadException > modelErrors Optional the error that occured while creating the model. Properties | Improve this Doc View Source GenericParameters List of the generic parameters assigned. Declaration public IReadOnlyList GenericParameters { get; } Property Value Type Description IReadOnlyList < CsGenericParameter > | Improve this Doc View Source GenericTypes List of the strong types that are implemented for each generic parameter. This will be an empty List when there is no generic types implemented. Declaration public IReadOnlyList GenericTypes { get; } Property Value Type Description IReadOnlyList < CsType > | Improve this Doc View Source HasParameters Flag that determines if the method has parameters assigned to it. Declaration public bool HasParameters { get; } Property Value Type Description Boolean | Improve this Doc View Source HasStrongTypesInGenerics Flag that determines if the generics implementation has strong types passed in to the generics implementation. Declaration public bool HasStrongTypesInGenerics { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAbstract Flag that determines if the method has been implemented as abstract. Declaration public bool IsAbstract { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAsync Flag that determines if the method implements the Async keyword. Declaration public bool IsAsync { get; } Property Value Type Description Boolean | Improve this Doc View Source IsExtension Flag that determines if the method is an extension method. Declaration public bool IsExtension { get; } Property Value Type Description Boolean | Improve this Doc View Source IsGeneric Flag the determines if this item supports generics Declaration public bool IsGeneric { get; } Property Value Type Description Boolean | Improve this Doc View Source IsOverride Flag that determines if the method has been overridden. Declaration public bool IsOverride { get; } Property Value Type Description Boolean | Improve this Doc View Source IsSealed Flag that determines if the method has been sealed. Declaration public bool IsSealed { get; } Property Value Type Description Boolean | Improve this Doc View Source IsStatic Flag that determines if this is a static method. Declaration public bool IsStatic { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVirtual Flag that determines if the method has been implemented as virtual. Declaration public bool IsVirtual { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVoid Flag that determines if the methods return type is void. Declaration public bool IsVoid { get; } Property Value Type Description Boolean | Improve this Doc View Source MethodType Determines the type of method that was loaded into this model. Declaration public CsMethodType MethodType { get; } Property Value Type Description CsMethodType | Improve this Doc View Source Parameters Enumeration of the parameters that have been assigned to the method. If HasParameters property is set to false this will be null. Declaration public IReadOnlyList Parameters { get; } Property Value Type Description IReadOnlyList < CsParameter > | Improve this Doc View Source 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 public CsType ReturnType { get; } Property Value Type Description CsType Methods | Improve this Doc View Source GetBodySyntaxAsync() The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code. Declaration public abstract Task GetBodySyntaxAsync() Returns Type Description Task < String > Explicit Interface Implementations | Improve this Doc View Source IDotNetGeneric.GenericParameters List of the generic parameters assigned. Declaration IReadOnlyList IDotNetGeneric.GenericParameters { get; } Returns Type Description IReadOnlyList < IDotNetGenericParameter > | Improve this Doc View Source IDotNetGeneric.GenericTypes Enumeration of the strong types that are implemented for each generic parameter. This will be an empty list when there is no generic types implemented. Declaration IReadOnlyList IDotNetGeneric.GenericTypes { get; } Returns Type Description IReadOnlyList < IDotNetType > | Improve this Doc View Source IDotNetMethod.MethodType Determines the type of method that was loaded into this model. Declaration DotNetMethodType IDotNetMethod.MethodType { get; } Returns Type Description DotNetMethodType | Improve this Doc View Source IDotNetMethod.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 IDotNetMethod.Parameters { get; } Returns Type Description IReadOnlyList < IDotNetParameter > | Improve this Doc View Source IDotNetMethod.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 IDotNetType IDotNetMethod.ReturnType { get; } Returns Type Description IDotNetType Implements ICsMethod ICsMember ICsModel ICsAttributes IParent ICsGeneric IDotNetMethod IDotNetMember IDotNetModel IModelStatus ISourceFiles IDotNetAttributes IDocumentation IParent ILookup IDotNetGeneric Extension Methods DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType) DotNetMemberExtensions.FormatCSharpDeclarationSyntax(IDotNetMethod, Boolean, Boolean, Boolean, Boolean) DotNetMemberExtensions.FormatCSharpComparisonHashCode(IDotNetMethod, Boolean, Boolean, Boolean) CSharpModelExtensions.ToModel(CsModel) CsMemberExtensions.FormatCSharpMemberComparisonHashCode(CsMember, MemberComparisonType) CsMemberExtensions.FormatCSharpDeclarationSyntax(CsMethod, Boolean, Boolean, Boolean) CsMemberExtensions.FormatCSharpComparisonHashCode(CsMethod, Boolean, Boolean, Boolean) InterfaceMemberExtensions.FormatInterfaceImplementationSignature(CsMethod, Boolean)"
+ "keywords": "Class CsMethod Data model that represents a method definition. Inheritance Object CsModel CsMember CsMethod Implements ICsMethod ICsMember ICsModel ICsAttributes IParent ICsGeneric IDotNetMethod IDotNetMember IDotNetModel IModelStatus ISourceFiles IDotNetAttributes IDocumentation IParent ILookup IDotNetGeneric Inherited Members CsMember.HasAttributes CsMember.Attributes CsMember.IDotNetAttributes.Attributes CsMember.SourceFiles CsMember.HasDocumentation CsMember.Documentation CsMember.IParent.Parent CsMember.LookupPath CsMember.Name CsMember.Security CsMember.MemberType CsMember.AddBeforeAsync(String, String) CsMember.AddBeforeAsync(String) CsMember.AddAfterAsync(String, String) CsMember.AddAfterAsync(String) CsMember.DeleteAsync(String) CsMember.DeleteAsync() CsMember.GetSourceLocationAsync(String) CsMember.GetSourceLocationAsync() CsMember.ReplaceAsync(String, String) CsMember.ReplaceAsync(String) CsMember.GetModel(String) CsMember.IDotNetMember.Security CsMember.IDotNetMember.MemberType CsMember.Parent CsModel.LocalModelErrors CsModel.ModelStore CsModel.IsLoaded CsModel.HasErrors CsModel.GetErrors() CsModel.LoadedFromSource CsModel.Language CsModel.ModelType CsModel.SourceDocument CsModel.IDotNetModel.ModelType CsModel.LookupModel(String) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : CodeFactory.DotNet.CSharp Assembly : CodeFactory.DotNet.dll Syntax public abstract class CsMethod : CsMember, ICsMethod, ICsMember, ICsModel, ICsAttributes, IParent, ICsGeneric, IDotNetMethod, IDotNetMember, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IParent, ILookup, IDotNetGeneric Constructors | Improve this Doc View Source CsMethod(Boolean, Boolean, Boolean, SourceCodeType, IReadOnlyList, IReadOnlyList, Boolean, String, String, String, String, CsSecurity, Boolean, Boolean, IReadOnlyList, IReadOnlyList, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, CsMethodType, CsType, IReadOnlyList, SyntaxType, String, ModelStore, IReadOnlyList) Constructor for the CsMethod Declaration protected CsMethod(bool isLoaded, bool hasErrors, bool loadedFromSource, SourceCodeType language, IReadOnlyList attributes, IReadOnlyList sourceFiles, bool hasDocumentation, string documentation, string lookupPath, string name, string parentPath, CsSecurity security, bool isGeneric, bool hasStrongTypesInGenerics, IReadOnlyList genericParameters, IReadOnlyList genericTypes, bool hasParameters, bool isAbstract, bool isVirtual, bool isSealed, bool isOverride, bool isStatic, bool isVoid, bool isAsync, bool isExtension, CsMethodType methodType, CsType returnType, IReadOnlyList parameters, SyntaxType contentSyntax = SyntaxType.Unknown, string sourceDocument = null, ModelStore modelStore = null, IReadOnlyList modelErrors = null) Parameters Type Name Description Boolean isLoaded Flag that determines if the model was loaded. Boolean hasErrors Flag that determine if errors were found creating the model. Boolean loadedFromSource Flag that determines if the model was loaded from source code or from an existing library. SourceCodeType language The target language the model was generated from. IReadOnlyList < CsAttribute > attributes List of the attributes assigned to this model. IReadOnlyList < String > sourceFiles List of the fully qualified paths to the source code files this member is defined in. Boolean hasDocumentation Flag that determines if the model has XML documentation assigned to it. String documentation The xml documentation assigned to the model. String lookupPath The fully qualified model lookup path for this model. String name The name of the model. String parentPath THe fully qualified lookup path for the parent model to this one. CsSecurity security The security scope assigned to this model. Boolean isGeneric Flag that determines if the method is a generic definition. Boolean hasStrongTypesInGenerics Flag that determines if the generics use strong type definitions. IReadOnlyList < CsGenericParameter > genericParameters Generic parameters assigned to the method. IReadOnlyList < CsType > genericTypes Target types for the generic parameters assigned to the method. Boolean hasParameters Flag that determines if the method had parameters. Boolean isAbstract Flag that determines if the model is abstract. Boolean isVirtual Flag that determines if the model is virtual. Boolean isSealed Flag that determines if the model is sealed. Boolean isOverride Flag that determines if the model is overridden. Boolean isStatic Flag that determines if the model is static. Boolean isVoid Flag that determines if the return type is void. Boolean isAsync Flag that determines if the method has the async keyword assigned. Boolean isExtension Flag that determines if the method is an extension method. CsMethodType methodType The type of method that was implemented. CsType returnType The type definition for the return type. IReadOnlyList < CsParameter > parameters The parameters assigned to the method. SyntaxType contentSyntax How syntax is stored in the method. String sourceDocument The source document that was used to build this model. This is optional parameter and can be null. ModelStore < ICsModel > modelStore Optional the lookup storage for models created during the compile or lookup of the model. IReadOnlyList < ModelLoadException > modelErrors Optional the error that occurred while creating the model. Properties | Improve this Doc View Source GenericParameters List of the generic parameters assigned. Declaration public IReadOnlyList GenericParameters { get; } Property Value Type Description IReadOnlyList < CsGenericParameter > | Improve this Doc View Source GenericTypes List of the strong types that are implemented for each generic parameter. This will be an empty List when there is no generic types implemented. Declaration public IReadOnlyList GenericTypes { get; } Property Value Type Description IReadOnlyList < CsType > | Improve this Doc View Source HasParameters Flag that determines if the method has parameters assigned to it. Declaration public bool HasParameters { get; } Property Value Type Description Boolean | Improve this Doc View Source HasStrongTypesInGenerics Flag that determines if the generics implementation has strong types passed in to the generics implementation. Declaration public bool HasStrongTypesInGenerics { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAbstract Flag that determines if the method has been implemented as abstract. Declaration public bool IsAbstract { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAsync Flag that determines if the method implements the Async keyword. Declaration public bool IsAsync { get; } Property Value Type Description Boolean | Improve this Doc View Source IsExtension Flag that determines if the method is an extension method. Declaration public bool IsExtension { get; } Property Value Type Description Boolean | Improve this Doc View Source IsGeneric Flag the determines if this item supports generics Declaration public bool IsGeneric { get; } Property Value Type Description Boolean | Improve this Doc View Source IsOverride Flag that determines if the method has been overridden. Declaration public bool IsOverride { get; } Property Value Type Description Boolean | Improve this Doc View Source IsSealed Flag that determines if the method has been sealed. Declaration public bool IsSealed { get; } Property Value Type Description Boolean | Improve this Doc View Source IsStatic Flag that determines if this is a static method. Declaration public bool IsStatic { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVirtual Flag that determines if the method has been implemented as virtual. Declaration public bool IsVirtual { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVoid Flag that determines if the methods return type is void. Declaration public bool IsVoid { get; } Property Value Type Description Boolean | Improve this Doc View Source MethodType Determines the type of method that was loaded into this model. Declaration public CsMethodType MethodType { get; } Property Value Type Description CsMethodType | Improve this Doc View Source Parameters Enumeration of the parameters that have been assigned to the method. If HasParameters property is set to false this will be null. Declaration public IReadOnlyList Parameters { get; } Property Value Type Description IReadOnlyList < CsParameter > | Improve this Doc View Source 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 public CsType ReturnType { get; } Property Value Type Description CsType | Improve this Doc View Source SyntaxContent Determines how the internal syntax for the method is stored. Declaration public SyntaxType SyntaxContent { get; } Property Value Type Description SyntaxType Methods | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source DeleteBodySyntaxAsync() Deletes the source syntax from the method body. The ContentSyntax must be set to Body or else an exception will be thrown. Declaration public abstract Task 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. | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source GetBodySyntaxAsync() The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body. Declaration public abstract Task GetBodySyntaxAsync() Returns Type Description Task < String > | Improve this Doc View Source GetBodySyntaxListAsync() The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body. This will return each line of code that has a line feed or return as a separate string. Declaration public abstract Task> GetBodySyntaxListAsync() Returns Type Description Task < List < String >> | Improve this Doc View Source GetExpressionSyntaxAsync() Gets the expression that has been assigned to the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Expression. Declaration public abstract Task GetExpressionSyntaxAsync() Returns Type Description Task < String > | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source 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 public abstract Task 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. | Improve this Doc View Source 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 public abstract Task 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. Explicit Interface Implementations | Improve this Doc View Source IDotNetGeneric.GenericParameters List of the generic parameters assigned. Declaration IReadOnlyList IDotNetGeneric.GenericParameters { get; } Returns Type Description IReadOnlyList < IDotNetGenericParameter > | Improve this Doc View Source IDotNetGeneric.GenericTypes Enumeration of the strong types that are implemented for each generic parameter. This will be an empty list when there is no generic types implemented. Declaration IReadOnlyList IDotNetGeneric.GenericTypes { get; } Returns Type Description IReadOnlyList < IDotNetType > | Improve this Doc View Source IDotNetMethod.MethodType Determines the type of method that was loaded into this model. Declaration DotNetMethodType IDotNetMethod.MethodType { get; } Returns Type Description DotNetMethodType | Improve this Doc View Source IDotNetMethod.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 IDotNetMethod.Parameters { get; } Returns Type Description IReadOnlyList < IDotNetParameter > | Improve this Doc View Source IDotNetMethod.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 IDotNetType IDotNetMethod.ReturnType { get; } Returns Type Description IDotNetType Implements ICsMethod ICsMember ICsModel ICsAttributes IParent ICsGeneric IDotNetMethod IDotNetMember IDotNetModel IModelStatus ISourceFiles IDotNetAttributes IDocumentation IParent ILookup IDotNetGeneric Extension Methods DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType) DotNetMemberExtensions.FormatCSharpDeclarationSyntax(IDotNetMethod, Boolean, Boolean, Boolean, Boolean) DotNetMemberExtensions.FormatCSharpComparisonHashCode(IDotNetMethod, Boolean, Boolean, Boolean) CSharpModelExtensions.ToModel(CsModel) CsMemberExtensions.FormatCSharpMemberComparisonHashCode(CsMember, MemberComparisonType) CsMemberExtensions.FormatCSharpDeclarationSyntax(CsMethod, Boolean, Boolean, Boolean) CsMemberExtensions.FormatCSharpComparisonHashCode(CsMethod, Boolean, Boolean, Boolean) InterfaceMemberExtensions.FormatInterfaceImplementationSignature(CsMethod, Boolean)"
},
"api/CodeFactory.DotNet.CSharp.CsMethodType.html": {
"href": "api/CodeFactory.DotNet.CSharp.CsMethodType.html",
@@ -357,7 +357,7 @@
"api/CodeFactory.DotNet.CSharp.ICsMethod.html": {
"href": "api/CodeFactory.DotNet.CSharp.ICsMethod.html",
"title": "Interface ICsMethod | CodeFactory Guidance",
- "keywords": "Interface ICsMethod Model definition of a method in c#. Inherited Members ICsMember.Security ICsMember.MemberType ICsMember.AddBeforeAsync(String, String) ICsMember.AddBeforeAsync(String) 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.GetModel(String) ICsModel.ModelType 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.GetBodySyntaxAsync() IDotNetMember.Name IDotNetModel.LoadedFromSource IDotNetModel.Language IDotNetModel.SourceDocument IModelStatus.IsLoaded IModelStatus.HasErrors IModelStatus.GetErrors() ISourceFiles.SourceFiles IDotNetAttributes.HasAttributes IDocumentation.HasDocumentation IDocumentation.Documentation 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 | Improve this Doc View Source MethodType Determines the type of method that was loaded into this model. Declaration CsMethodType MethodType { get; } Property Value Type Description CsMethodType | Improve this Doc View Source 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 Parameters { get; } Property Value Type Description IReadOnlyList < CsParameter > | Improve this Doc View Source ReturnType The type information about the return type assigned to the method. if flag is true then the return type will be set to null. Declaration CsType ReturnType { get; } Property Value Type Description CsType Extension Methods DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType) DotNetMemberExtensions.FormatCSharpDeclarationSyntax(IDotNetMethod, Boolean, Boolean, Boolean, Boolean) DotNetMemberExtensions.FormatCSharpComparisonHashCode(IDotNetMethod, Boolean, Boolean, Boolean)"
+ "keywords": "Interface ICsMethod Model definition of a method in c#. Inherited Members ICsMember.Security ICsMember.MemberType ICsMember.AddBeforeAsync(String, String) ICsMember.AddBeforeAsync(String) 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.GetModel(String) ICsModel.ModelType 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 IDotNetAttributes.HasAttributes IDocumentation.HasDocumentation IDocumentation.Documentation 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 | Improve this Doc View Source MethodType Determines the type of method that was loaded into this model. Declaration CsMethodType MethodType { get; } Property Value Type Description CsMethodType | Improve this Doc View Source 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 Parameters { get; } Property Value Type Description IReadOnlyList < CsParameter > | Improve this Doc View Source 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 | Improve this Doc View Source 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 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. | Improve this Doc View Source 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 Task 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. | Improve this Doc View Source 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 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. | Improve this Doc View Source 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 Task 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. | Improve this Doc View Source 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 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. | Improve this Doc View Source 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 Task 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. | Improve this Doc View Source 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 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. | Improve this Doc View Source 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 Task 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. | Improve this Doc View Source 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 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. | Improve this Doc View Source 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 Task 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. Extension Methods DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType) DotNetMemberExtensions.FormatCSharpDeclarationSyntax(IDotNetMethod, Boolean, Boolean, Boolean, Boolean) DotNetMemberExtensions.FormatCSharpComparisonHashCode(IDotNetMethod, Boolean, Boolean, Boolean)"
},
"api/CodeFactory.DotNet.CSharp.ICsModel.html": {
"href": "api/CodeFactory.DotNet.CSharp.ICsModel.html",
@@ -467,7 +467,7 @@
"api/CodeFactory.DotNet.html": {
"href": "api/CodeFactory.DotNet.html",
"title": "Namespace CodeFactory.DotNet | CodeFactory Guidance",
- "keywords": "Namespace CodeFactory.DotNet Classes DotNetContainerExtensions Extension management class that manages dot net models that implement the IDotNetContainer interface. DotNetMemberExtensions Extension methods that support model that implement the IDotNetMember interface. DotNetModelExtensions Extension methods that support models that implement IDotNetModel PathBuilderConstants Data constants that are used when building the unique path for a dot net model. Interfaces IDocumentation Interface that determines if a model has code level documentation. IDotNetAttribute Model definition for an attribute in a .net implementation. IDotNetAttributeParameter The model information for a attribute used for a .net implementation. IDotNetAttributeParameterValue The model information for an attributes parameter value for .net implementation. IDotNetAttributes Interface that determines if a .net model has attributes assigned. IDotNetClass Model definition for a class in .net. IDotNetContainer The base implementation all container type models must implement in .net. IDotNetDelegate Model definition of a delegate in .net. IDotNetEnum Data model that provides information on an enumeration. IDotNetEnumValue Data model that provides information to a specific enumeration value implemented in an enumeration. IDotNetEvent Model definition of a event in .net. IDotNetField Model definition of a field in .net. IDotNetGeneric Definition that determines if the .net model implements generics. IDotNetGenericParameter Model contract for information about a parameter used in a generic definition. IDotNetInterface Mode definition for an interface in .net. IDotNetMember Base definition for all .net member models. IDotNetMethod Model definition of a method in .net. IDotNetModel Base implementation all dot net models must implement. IDotNetNamespace Model definition for a namespace definition inside a code file in .net. IDotNetNamespaceReference A namespace that is being referenced by dot net source code. This will determine which external library resources will be available in the source control document. IDotNetParameter The definition of a parameter used in .Net. IDotNetParameterDefaultValue Model that represents a default value for a IDotNetParameter model. IDotNetProperty Model definition of a property in .net. IDotNetSource The source point in which dot net models are loaded. IDotNetStructure Model definition for a structure in .net. IDotNetTupleTypeParameter Data model that tracks an individual part of a tuple definition. IDotNetType Model that defines a .net type. ILookup Defines lookup information for a model that supports being searched for. IParent Defines information how to find the parent model for the model that implements this dot net model. IT4Factory Definition of data that will be provided to all T4 factories. Enums AttributeParameterKind Enumeration that determines the type of attribute parameter data that is being returned. DotNetContainerType Enumeration that determines the type of dot net container. DotNetMemberType The type of dot net member. DotNetMethodType Enumeration of the type of methods that are supported in .Net DotNetModelType The models types that implemented at the dot net level and not at a target language level. DotNetSecurity Enumeration of the security scope the target .net model is set to. Language The target .net language for code factory. MemberComparisonType Enumeration of the types of member comparison ParameterDefaultValueType WellKnownLanguageType Enumeration that identifies well know types used by various .net languages."
+ "keywords": "Namespace CodeFactory.DotNet Classes DotNetContainerExtensions Extension management class that manages dot net models that implement the IDotNetContainer interface. DotNetMemberExtensions Extension methods that support model that implement the IDotNetMember interface. DotNetModelExtensions Extension methods that support models that implement IDotNetModel PathBuilderConstants Data constants that are used when building the unique path for a dot net model. Interfaces IDocumentation Interface that determines if a model has code level documentation. IDotNetAttribute Model definition for an attribute in a .net implementation. IDotNetAttributeParameter The model information for a attribute used for a .net implementation. IDotNetAttributeParameterValue The model information for an attributes parameter value for .net implementation. IDotNetAttributes Interface that determines if a .net model has attributes assigned. IDotNetClass Model definition for a class in .net. IDotNetContainer The base implementation all container type models must implement in .net. IDotNetDelegate Model definition of a delegate in .net. IDotNetEnum Data model that provides information on an enumeration. IDotNetEnumValue Data model that provides information to a specific enumeration value implemented in an enumeration. IDotNetEvent Model definition of a event in .net. IDotNetField Model definition of a field in .net. IDotNetGeneric Definition that determines if the .net model implements generics. IDotNetGenericParameter Model contract for information about a parameter used in a generic definition. IDotNetInterface Mode definition for an interface in .net. IDotNetMember Base definition for all .net member models. IDotNetMethod Model definition of a method in .net. IDotNetModel Base implementation all dot net models must implement. IDotNetNamespace Model definition for a namespace definition inside a code file in .net. IDotNetNamespaceReference A namespace that is being referenced by dot net source code. This will determine which external library resources will be available in the source control document. IDotNetParameter The definition of a parameter used in .Net. IDotNetParameterDefaultValue Model that represents a default value for a IDotNetParameter model. IDotNetProperty Model definition of a property in .net. IDotNetSource The source point in which dot net models are loaded. IDotNetStructure Model definition for a structure in .net. IDotNetTupleTypeParameter Data model that tracks an individual part of a tuple definition. IDotNetType Model that defines a .net type. ILookup Defines lookup information for a model that supports being searched for. IParent Defines information how to find the parent model for the model that implements this dot net model. IT4Factory Definition of data that will be provided to all T4 factories. Enums AttributeParameterKind Enumeration that determines the type of attribute parameter data that is being returned. DotNetContainerType Enumeration that determines the type of dot net container. DotNetMemberType The type of dot net member. DotNetMethodType Enumeration of the type of methods that are supported in .Net DotNetModelType The models types that implemented at the dot net level and not at a target language level. DotNetSecurity Enumeration of the security scope the target .net model is set to. Language The target .net language for code factory. MemberComparisonType Enumeration of the types of member comparison ParameterDefaultValueType SyntaxType Determines the type of syntax that is hosted in a Dot Net model. WellKnownLanguageType Enumeration that identifies well know types used by various .net languages."
},
"api/CodeFactory.DotNet.IDocumentation.html": {
"href": "api/CodeFactory.DotNet.IDocumentation.html",
@@ -552,7 +552,7 @@
"api/CodeFactory.DotNet.IDotNetMethod.html": {
"href": "api/CodeFactory.DotNet.IDotNetMethod.html",
"title": "Interface IDotNetMethod | CodeFactory Guidance",
- "keywords": "Interface IDotNetMethod Model definition of a method in .net. Inherited Members IDotNetMember.Name IDotNetMember.Security IDotNetMember.MemberType IDotNetModel.LoadedFromSource IDotNetModel.Language IDotNetModel.ModelType IDotNetModel.SourceDocument IModelStatus.IsLoaded IModelStatus.HasErrors IModelStatus.GetErrors() ISourceFiles.SourceFiles IDotNetAttributes.HasAttributes IDotNetAttributes.Attributes IDocumentation.HasDocumentation IDocumentation.Documentation IParent.Parent ILookup.LookupPath IDotNetGeneric.IsGeneric IDotNetGeneric.GenericParameters IDotNetGeneric.HasStrongTypesInGenerics IDotNetGeneric.GenericTypes Namespace : CodeFactory.DotNet Assembly : CodeFactory.DotNet.dll Syntax public interface IDotNetMethod : IDotNetMember, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IParent, ILookup, IDotNetGeneric Properties | Improve this Doc View Source HasParameters Flag that determines if the method has parameters assigned to it. Declaration bool HasParameters { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAbstract Flag that determines if the method has been implemented as abstract. Declaration bool IsAbstract { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAsync Flag that determines if the method implements the Async keyword. Declaration bool IsAsync { get; } Property Value Type Description Boolean | Improve this Doc View Source IsExtension Flag that determines if the method is an extension method. Declaration bool IsExtension { get; } Property Value Type Description Boolean | Improve this Doc View Source IsOverride Flag that determines if the method has been overridden. Declaration bool IsOverride { get; } Property Value Type Description Boolean | Improve this Doc View Source IsSealed Flag that determines if the method has been sealed. Declaration bool IsSealed { get; } Property Value Type Description Boolean | Improve this Doc View Source IsStatic Flag that determines if this is a static method. Declaration bool IsStatic { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVirtual Flag that determines if the method has been implemented as virtual. Declaration bool IsVirtual { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVoid Flag that determines if the methods return type is void. Declaration bool IsVoid { get; } Property Value Type Description Boolean | Improve this Doc View Source MethodType Determines the type of method that was loaded into this model. Declaration DotNetMethodType MethodType { get; } Property Value Type Description DotNetMethodType | Improve this Doc View Source 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 Parameters { get; } Property Value Type Description IReadOnlyList < IDotNetParameter > | Improve this Doc View Source 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 IDotNetType ReturnType { get; } Property Value Type Description IDotNetType Methods | Improve this Doc View Source GetBodySyntaxAsync() The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code. Declaration Task GetBodySyntaxAsync() Returns Type Description Task < String > Extension Methods DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType) DotNetMemberExtensions.FormatCSharpDeclarationSyntax(IDotNetMethod, Boolean, Boolean, Boolean, Boolean) DotNetMemberExtensions.FormatCSharpComparisonHashCode(IDotNetMethod, Boolean, Boolean, Boolean)"
+ "keywords": "Interface IDotNetMethod Model definition of a method in .net. Inherited Members IDotNetMember.Name IDotNetMember.Security IDotNetMember.MemberType IDotNetModel.LoadedFromSource IDotNetModel.Language IDotNetModel.ModelType IDotNetModel.SourceDocument IModelStatus.IsLoaded IModelStatus.HasErrors IModelStatus.GetErrors() ISourceFiles.SourceFiles IDotNetAttributes.HasAttributes IDotNetAttributes.Attributes IDocumentation.HasDocumentation IDocumentation.Documentation IParent.Parent ILookup.LookupPath IDotNetGeneric.IsGeneric IDotNetGeneric.GenericParameters IDotNetGeneric.HasStrongTypesInGenerics IDotNetGeneric.GenericTypes Namespace : CodeFactory.DotNet Assembly : CodeFactory.DotNet.dll Syntax public interface IDotNetMethod : IDotNetMember, IDotNetModel, IModelStatus, ISourceFiles, IDotNetAttributes, IDocumentation, IParent, ILookup, IDotNetGeneric Properties | Improve this Doc View Source HasParameters Flag that determines if the method has parameters assigned to it. Declaration bool HasParameters { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAbstract Flag that determines if the method has been implemented as abstract. Declaration bool IsAbstract { get; } Property Value Type Description Boolean | Improve this Doc View Source IsAsync Flag that determines if the method implements the Async keyword. Declaration bool IsAsync { get; } Property Value Type Description Boolean | Improve this Doc View Source IsExtension Flag that determines if the method is an extension method. Declaration bool IsExtension { get; } Property Value Type Description Boolean | Improve this Doc View Source IsOverride Flag that determines if the method has been overridden. Declaration bool IsOverride { get; } Property Value Type Description Boolean | Improve this Doc View Source IsSealed Flag that determines if the method has been sealed. Declaration bool IsSealed { get; } Property Value Type Description Boolean | Improve this Doc View Source IsStatic Flag that determines if this is a static method. Declaration bool IsStatic { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVirtual Flag that determines if the method has been implemented as virtual. Declaration bool IsVirtual { get; } Property Value Type Description Boolean | Improve this Doc View Source IsVoid Flag that determines if the methods return type is void. Declaration bool IsVoid { get; } Property Value Type Description Boolean | Improve this Doc View Source MethodType Determines the type of method that was loaded into this model. Declaration DotNetMethodType MethodType { get; } Property Value Type Description DotNetMethodType | Improve this Doc View Source 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 Parameters { get; } Property Value Type Description IReadOnlyList < IDotNetParameter > | Improve this Doc View Source 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 IDotNetType ReturnType { get; } Property Value Type Description IDotNetType | Improve this Doc View Source SyntaxContent Determines how the internal syntax for the method is stored. Declaration SyntaxType SyntaxContent { get; } Property Value Type Description SyntaxType Methods | Improve this Doc View Source GetBodySyntaxAsync() The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body. Declaration Task GetBodySyntaxAsync() Returns Type Description Task < String > | Improve this Doc View Source GetBodySyntaxListAsync() The source code syntax that is stored in the body of the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Body. This will return each line of code that has a line feed or return as a separate string. Declaration Task> GetBodySyntaxListAsync() Returns Type Description Task < List < String >> | Improve this Doc View Source GetExpressionSyntaxAsync() Gets the expression that has been assigned to the method. This will be null if the method was not loaded from source code or the SyntaxContent is not set to Expression. Declaration Task GetExpressionSyntaxAsync() Returns Type Description Task < String > Extension Methods DotNetMemberExtensions.FormatCSharpMemberComparisonHashCode(IDotNetMember, MemberComparisonType) DotNetMemberExtensions.FormatCSharpDeclarationSyntax(IDotNetMethod, Boolean, Boolean, Boolean, Boolean) DotNetMemberExtensions.FormatCSharpComparisonHashCode(IDotNetMethod, Boolean, Boolean, Boolean)"
},
"api/CodeFactory.DotNet.IDotNetModel.html": {
"href": "api/CodeFactory.DotNet.IDotNetModel.html",
@@ -639,6 +639,11 @@
"title": "Class PathBuilderConstants | CodeFactory Guidance",
"keywords": "Class PathBuilderConstants Data constants that are used when building the unique path for a dot net model. Inheritance Object PathBuilderConstants Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : CodeFactory.DotNet Assembly : CodeFactory.DotNet.dll Syntax public static class PathBuilderConstants Fields | Improve this Doc View Source Attribute Definition of a attribute model in the path for a dot net model. Declaration public const string Attribute = \"/A:\" Field Value Type Description String | Improve this Doc View Source Class Definition of a class model in the path for a dot net model. Declaration public const string Class = \"/C:\" Field Value Type Description String | Improve this Doc View Source Delegate Definition of a delegate model in the path for a dot net model. Declaration public const string Delegate = \"/D:\" Field Value Type Description String | Improve this Doc View Source Enum Definition of a enumeration model in the path for a dot net model. Declaration public const string Enum = \"/EN:\" Field Value Type Description String | Improve this Doc View Source EnumValue Definition of a enumeration value model in the path for a dot net model. Declaration public const string EnumValue = \"/ENV:\" Field Value Type Description String | Improve this Doc View Source Event Definition of a event model in the path for a dot net model. Declaration public const string Event = \"/E:\" Field Value Type Description String | Improve this Doc View Source Field Definition of a field model in the path for a dot net model. Declaration public const string Field = \"/F:\" Field Value Type Description String | Improve this Doc View Source Interface Definition of a interface model in the path for a dot net model. Declaration public const string Interface = \"/I:\" Field Value Type Description String | Improve this Doc View Source Method Definition of a method model in the path for a dot net model. Declaration public const string Method = \"/M:\" Field Value Type Description String | Improve this Doc View Source Namespace Definition of a namespace path for a dot net model. Declaration public const string Namespace = \"/NS:\" Field Value Type Description String | Improve this Doc View Source NamespaceReference Reference to a namespace that is used in a dot net model. Declaration public const string NamespaceReference = \"/NSREF:\" Field Value Type Description String | Improve this Doc View Source Parameter Definition of a parameter model in the path for a dot net model. Declaration public const string Parameter = \"/PARM:\" Field Value Type Description String | Improve this Doc View Source ParameterDefaultValue Definition of a parameter model default value in the path for a dot net model. Declaration public const string ParameterDefaultValue = \"/PARMDV:\" Field Value Type Description String | Improve this Doc View Source Property Definition of a property model in the path for a dot net model. Declaration public const string Property = \"/P:\" Field Value Type Description String | Improve this Doc View Source Source Definition of the source entry point that holds all dot net models. Declaration public const string Source = \"//SRC:\" Field Value Type Description String | Improve this Doc View Source Structure Definition of a structure model in the path for a dot net model. Declaration public const string Structure = \"/S:\" Field Value Type Description String"
},
+ "api/CodeFactory.DotNet.SyntaxType.html": {
+ "href": "api/CodeFactory.DotNet.SyntaxType.html",
+ "title": "Enum SyntaxType | CodeFactory Guidance",
+ "keywords": "Enum SyntaxType Determines the type of syntax that is hosted in a Dot Net model. Namespace : CodeFactory.DotNet Assembly : CodeFactory.DotNet.dll Syntax public enum SyntaxType Fields Name Description Body The syntax is hosted in the body of the target model. Expression The syntax is hosted in a single expression using a => directive. Unknown No syntax definition has been identified or an unknown declaration was used."
+ },
"api/CodeFactory.DotNet.WellKnownLanguageType.html": {
"href": "api/CodeFactory.DotNet.WellKnownLanguageType.html",
"title": "Enum WellKnownLanguageType | CodeFactory Guidance",
@@ -747,7 +752,7 @@
"api/CodeFactory.VisualStudio.html": {
"href": "api/CodeFactory.VisualStudio.html",
"title": "Namespace CodeFactory.VisualStudio | CodeFactory Guidance",
- "keywords": "Namespace CodeFactory.VisualStudio Classes CSharpSourceExtensions Extensions management class for the model IVsCSharpSource FileHelper Static helper class that contains functions to support file management with visual studio. PathHelper Static helper class that contains functions to support path management with visual studio. ProjectSystemException Code factory exception that occurs when accessing visual studios project system. SolutionExplorerException Exception that is raised when there are problem accessing needed resources from visual studio's solution explorer. VisualStudioException Base exception class for all visual studio specific exceptions that occur in code factory. VisualStudioMessages A strongly-typed resource class, for looking up localized strings, etc. VsCommandBase Base implementation for a factory command that supports integration with visual studio. VsCSharpSource Data model that represents C# source code. VsCSharpSourceExtensions Extensions class that provides common automation tasks rolled up under standard extension methods that support the VsCSharpSource model. VsDocument Data model that represents a document that is hosted in visual studio. VsModel Base class used by all visual studio models. VsProject Data model that presents a visual studio project that has been loaded. VsProjectExtensions Extensions class that provides common automation tasks rolled up under standard extension methods that support the VsProject model. VsProjectFolder Data model that represents a folder in a project hosted in visual studio. VsReference Data model that presents a visual studio reference that has been loaded. VsSolution Data model that represents the loaded solution in visual studio. VsSolutionFolder Data model that represents a solution folder in a loaded solution. Interfaces IChildren Defining if the visual studio object has child objects. IParent Interface to determine IVsActions Code factory commands that are globally used in Visual Studio. IVsCommandInformation Interface that provides information used by code factory to load the command. IVsCSharpSource Visual studio model that loads the source from a C# document. IVsDocument Definition of a document associated with a project in visual studio. IVsDocumentActions Visual studio actions that support the IVsDocument model. IVsFactoryCommand Common implementation all code factory commands for visual studio must display. IVsModel IVsProject Definition of a visual studio project model information. IVsProjectActions Visual studio actions that support the IVsProject model. IVsProjectFolder Definition of a visual studio project folder model information. IVsProjectFolderActions Visual studio actions that support the IVsProjectFolder model. IVsReference Definition of a visual studio project reference model information. IVsReferenceActions Visual studio actions that support the IVsReference model. IVsSolution Model of the solution that is currently loaded in visual studio. IVsSolutionActions Actions that can be used with the a IVsSolution model. IVsSolutionFolder Model of a solution folder that is currently loaded in visual studio. IVsSolutionFolderActions Visual studio actions that support the IVsSolutionFolder model. IVsSourceActions The visual studio actions that support source models. Enums ProjectLanguage Definition of the a language has compiler support within a target project. ProjectReferenceType Enumeration VisualStudioModelType Enumeration of the different type of code factory models that support visual studio integration. VsCommandType Enumeration that determines the type of visual studio command is being executed. VsDocumentType Enumeration that determines the type of visual studio document that has been loaded."
+ "keywords": "Namespace CodeFactory.VisualStudio Classes CSharpSourceExtensions Extensions management class for the model IVsCSharpSource FileHelper Static helper class that contains functions to support file management with visual studio. PathHelper Static helper class that contains functions to support path management with visual studio. ProjectSystemException Code factory exception that occurs when accessing visual studios project system. SolutionExplorerException Exception that is raised when there are problem accessing needed resources from visual studio's solution explorer. VisualStudioException Base exception class for all visual studio specific exceptions that occur in code factory. VisualStudioMessages A strongly-typed resource class, for looking up localized strings, etc. VsCommandBase Base implementation for a factory command that supports integration with visual studio. VsCSharpSource Data model that represents C# source code. VsCSharpSourceExtensions Extensions class that provides common automation tasks rolled up under standard extension methods that support the VsCSharpSource model. VsDocument Data model that represents a document that is hosted in visual studio. VsModel Base class used by all visual studio models. VsProject Data model that presents a visual studio project that has been loaded. VsProjectExtensions Extensions class that provides common automation tasks rolled up under standard extension methods that support the VsProject model. VsProjectFolder Data model that represents a folder in a project hosted in visual studio. VsProjectFramework Data class that implements IVsProjectFramework VsReference Data model that presents a visual studio reference that has been loaded. VsSolution Data model that represents the loaded solution in visual studio. VsSolutionFolder Data model that represents a solution folder in a loaded solution. Interfaces IChildren Defining if the visual studio object has child objects. IParent Interface to determine IVsActions Code factory commands that are globally used in Visual Studio. IVsCommandInformation Interface that provides information used by code factory to load the command. IVsCSharpSource Visual studio model that loads the source from a C# document. IVsDocument Definition of a document associated with a project in visual studio. IVsDocumentActions Visual studio actions that support the IVsDocument model. IVsEnvironmentActions Visual Studio actions handle interaction with Visual Studio itself. IVsFactoryCommand Common implementation all code factory commands for visual studio must display. IVsModel IVsProject Definition of a visual studio project model information. IVsProjectActions Visual studio actions that support the IVsProject model. IVsProjectFolder Definition of a visual studio project folder model information. IVsProjectFolderActions Visual studio actions that support the IVsProjectFolder model. IVsProjectFramework Target framework in which the project will output to. IVsReference Definition of a visual studio project reference model information. IVsReferenceActions Visual studio actions that support the IVsReference model. IVsSolution Model of the solution that is currently loaded in visual studio. IVsSolutionActions Actions that can be used with the a IVsSolution model. IVsSolutionFolder Model of a solution folder that is currently loaded in visual studio. IVsSolutionFolderActions Visual studio actions that support the IVsSolutionFolder model. IVsSourceActions The visual studio actions that support source models. Enums ProjectLanguage Definition of the a language has compiler support within a target project. ProjectReferenceType Enumeration VisualStudioModelType Enumeration of the different type of code factory models that support visual studio integration. VsCommandType Enumeration that determines the type of visual studio command is being executed. VsDocumentType Enumeration that determines the type of visual studio document that has been loaded."
},
"api/CodeFactory.VisualStudio.IChildren.html": {
"href": "api/CodeFactory.VisualStudio.IChildren.html",
@@ -762,7 +767,7 @@
"api/CodeFactory.VisualStudio.IVsActions.html": {
"href": "api/CodeFactory.VisualStudio.IVsActions.html",
"title": "Interface IVsActions | CodeFactory Guidance",
- "keywords": "Interface IVsActions Code factory commands that are globally used in Visual Studio. Namespace : CodeFactory.VisualStudio Assembly : CodeFactory.VisualStudio.dll Syntax public interface IVsActions Properties | Improve this Doc View Source DocumentActions Visual studio actions that work with the IVsDocument model. Declaration IVsDocumentActions DocumentActions { get; } Property Value Type Description IVsDocumentActions | Improve this Doc View Source ProjectActions Visual studio actions that work with the IVsProject model. Declaration IVsProjectActions ProjectActions { get; } Property Value Type Description IVsProjectActions | Improve this Doc View Source ProjectFolderActions Visual studio actions that work with the IVsProjectFolder model. Declaration IVsProjectFolderActions ProjectFolderActions { get; } Property Value Type Description IVsProjectFolderActions | Improve this Doc View Source ProjectReferenceActions Visual studio actions that work with the IVsReference model. Declaration IVsReferenceActions ProjectReferenceActions { get; } Property Value Type Description IVsReferenceActions | Improve this Doc View Source SolutionActions Visual studio actions that work with the IVsSolution model. Declaration IVsSolutionActions SolutionActions { get; } Property Value Type Description IVsSolutionActions | Improve this Doc View Source SolutionFolderActions Visual studio actions that work with the IVsSolutionFolder model. Declaration IVsSolutionFolderActions SolutionFolderActions { get; } Property Value Type Description IVsSolutionFolderActions | Improve this Doc View Source SourceActions Visual studio actions that work with source models. Declaration IVsSourceActions SourceActions { get; } Property Value Type Description IVsSourceActions | Improve this Doc View Source UserInterfaceActions Visual studio actions that work the the visual studio user interface. Declaration IVsUIActions UserInterfaceActions { get; } Property Value Type Description IVsUIActions Methods | Improve this Doc View Source GetSolutionAsync() Gets the most current model of the solution. Declaration Task GetSolutionAsync() Returns Type Description Task < VsSolution > The solution model."
+ "keywords": "Interface IVsActions Code factory commands that are globally used in Visual Studio. Namespace : CodeFactory.VisualStudio Assembly : CodeFactory.VisualStudio.dll Syntax public interface IVsActions Properties | Improve this Doc View Source DocumentActions Visual Studio actions that work with the IVsDocument model. Declaration IVsDocumentActions DocumentActions { get; } Property Value Type Description IVsDocumentActions | Improve this Doc View Source EnvironmentActions Visual Studio actions that directly interact with Visual Studio itself. Declaration IVsEnvironmentActions EnvironmentActions { get; } Property Value Type Description IVsEnvironmentActions | Improve this Doc View Source ProjectActions Visual Studio actions that work with the IVsProject model. Declaration IVsProjectActions ProjectActions { get; } Property Value Type Description IVsProjectActions | Improve this Doc View Source ProjectFolderActions Visual Studio actions that work with the IVsProjectFolder model. Declaration IVsProjectFolderActions ProjectFolderActions { get; } Property Value Type Description IVsProjectFolderActions | Improve this Doc View Source ProjectReferenceActions Visual Studio actions that work with the IVsReference model. Declaration IVsReferenceActions ProjectReferenceActions { get; } Property Value Type Description IVsReferenceActions | Improve this Doc View Source SolutionActions Visual Studio actions that work with the IVsSolution model. Declaration IVsSolutionActions SolutionActions { get; } Property Value Type Description IVsSolutionActions | Improve this Doc View Source SolutionFolderActions Visual Studio actions that work with the IVsSolutionFolder model. Declaration IVsSolutionFolderActions SolutionFolderActions { get; } Property Value Type Description IVsSolutionFolderActions | Improve this Doc View Source SourceActions Visual Studio actions that work with source models. Declaration IVsSourceActions SourceActions { get; } Property Value Type Description IVsSourceActions | Improve this Doc View Source UserInterfaceActions Visual Studio actions that work the the Visual Studio user interface. Declaration IVsUIActions UserInterfaceActions { get; } Property Value Type Description IVsUIActions Methods | Improve this Doc View Source GetSolutionAsync() Gets the most current model of the solution. Declaration Task GetSolutionAsync() Returns Type Description Task < VsSolution > The solution model."
},
"api/CodeFactory.VisualStudio.IVsCommandInformation.html": {
"href": "api/CodeFactory.VisualStudio.IVsCommandInformation.html",
@@ -784,6 +789,11 @@
"title": "Interface IVsDocumentActions | CodeFactory Guidance",
"keywords": "Interface IVsDocumentActions Visual studio actions that support the IVsDocument model. Namespace : CodeFactory.VisualStudio Assembly : CodeFactory.VisualStudio.dll Syntax public interface IVsDocumentActions Methods | Improve this Doc View Source AddContentAsync(VsDocument, IDocumentLocation, String) Adds content to a target starting at an assigned Declaration Task AddContentAsync(VsDocument source, IDocumentLocation location, string content) Parameters Type Name Description VsDocument source Document to have content added to. IDocumentLocation location Location within the document to add content to. String content The content to be added to the document. Returns Type Description Task | Improve this Doc View Source AddContentToBeginningAsync(VsDocument, String) Adds content to the beginning of a document. Declaration Task AddContentToBeginningAsync(VsDocument source, string content) Parameters Type Name Description VsDocument source Document to add content to. String content The content to be added. Returns Type Description Task | Improve this Doc View Source AddContentToEndAsync(VsDocument, String) Adds content to the end of a document. Declaration Task AddContentToEndAsync(VsDocument source, string content) Parameters Type Name Description VsDocument source Document to add content to. String content The content to be added. Returns Type Description Task | Improve this Doc View Source DeleteAsync(VsDocument) Deletes the document. Declaration Task DeleteAsync(VsDocument source) Parameters Type Name Description VsDocument source document to be deleted. Returns Type Description Task < Boolean > Flag that notifies if the delete operation completed successfully. Remarks Currently does not support deleting solution documents. | Improve this Doc View Source GetChildrenAsync(VsDocument, Boolean) Gets the direct children of the document. Declaration Task> GetChildrenAsync(VsDocument source, bool allChildren) Parameters Type Name Description VsDocument source The document to get children from. Boolean allChildren Flag that determines if all children from the document should be returned. Returns Type Description Task < IReadOnlyList < VsDocument >> Readonly list of all the project documents, if no children are found then an empty readonly list will be returned. | Improve this Doc View Source GetCSharpSourceModelAsync(VsDocument) If the document is implemented as a C# code model. Will return the C# source code model from the visual studio document. Declaration Task GetCSharpSourceModelAsync(VsDocument source) Parameters Type Name Description VsDocument source The source document to load the C# code model from. Returns Type Description Task < CsSource > The loaded model or null if the model could not be loaded. | Improve this Doc View Source GetDocumentContentAsContentAsync(VsDocument) Gets the content of the document. Declaration Task GetDocumentContentAsContentAsync(VsDocument source) Parameters Type Name Description VsDocument source The document to get content from. Returns Type Description Task < IDocumentContent > Document content as | Improve this Doc View Source GetDocumentContentAsStringAsync(VsDocument) Gets the content of the document. Declaration Task GetDocumentContentAsStringAsync(VsDocument source) Parameters Type Name Description VsDocument source The document to get content from. Returns Type Description Task < String > The content of the document or null if there is no content in the document. | Improve this Doc View Source GetDocumentContentAsStringAsync(VsDocument, IDocumentLocation, IDocumentLocation) Gets the content of the document. Declaration Task GetDocumentContentAsStringAsync(VsDocument source, IDocumentLocation startLocation, IDocumentLocation endLocation) Parameters Type Name Description VsDocument source The document to get content from. IDocumentLocation startLocation The starting position within the document to get content from. IDocumentLocation endLocation The ending position within the document to get content form. Returns Type Description Task < String > The content of the document or null if there is no content in the document. | Improve this Doc View Source GetParentAsync(VsDocument) Get the parent visual studio model of the document. Declaration Task GetParentAsync(VsDocument source) Parameters Type Name Description VsDocument source document to get the parent of. Returns Type Description Task < VsModel > Model of the parent of this document. The model will be returned unless there is no parent, otherwise null will be returned. | Improve this Doc View Source RemoveAsync(VsDocument) Removes a document from visual studio but does not remove it from the file system. Declaration Task RemoveAsync(VsDocument source) Parameters Type Name Description VsDocument source document to be removed. Returns Type Description Task < Boolean > Flag that notifies if the remove operation completed successfully. Remarks Currently does not support removing solution documents. | Improve this Doc View Source RemoveContentAsync(VsDocument) Removes all the content from a document. Declaration Task RemoveContentAsync(VsDocument source) Parameters Type Name Description VsDocument source Document to remove content from. Returns Type Description Task | Improve this Doc View Source RemoveContentAsync(VsDocument, IDocumentLocation, IDocumentLocation) Removes a target set of content from the document. Declaration Task RemoveContentAsync(VsDocument source, IDocumentLocation startLocation, IDocumentLocation endLocation) Parameters Type Name Description VsDocument source Document to remove content from. IDocumentLocation startLocation The starting position within the document to remove content from. IDocumentLocation endLocation The ending position within the document to remove content form. Returns Type Description Task | Improve this Doc View Source ReplaceContentAsync(VsDocument, String) Replaces all the content within the document. Declaration Task ReplaceContentAsync(VsDocument source, string content) Parameters Type Name Description VsDocument source The target document to have content replaced. String content Content to replace the existing content in the document. Returns Type Description Task | Improve this Doc View Source ReplaceContentAsync(VsDocument, String, IDocumentLocation, IDocumentLocation) Replaces all the content within the document. Declaration Task ReplaceContentAsync(VsDocument source, string content, IDocumentLocation startLocation, IDocumentLocation endLocation) Parameters Type Name Description VsDocument source The target document to have content replaced. String content Content to replace the existing content in the document. IDocumentLocation startLocation The starting position within the document to replace content. IDocumentLocation endLocation The ending location within the document to replace content. Returns Type Description Task"
},
+ "api/CodeFactory.VisualStudio.IVsEnvironmentActions.html": {
+ "href": "api/CodeFactory.VisualStudio.IVsEnvironmentActions.html",
+ "title": "Interface IVsEnvironmentActions | CodeFactory Guidance",
+ "keywords": "Interface IVsEnvironmentActions Visual Studio actions handle interaction with Visual Studio itself. Namespace : CodeFactory.VisualStudio Assembly : CodeFactory.VisualStudio.dll Syntax public interface IVsEnvironmentActions Methods | Improve this Doc View Source WriteToCodeFactoryOutputWindowAsync(String) Writes the provided message to the CodeFactory output window in Visual Studio. Declaration Task WriteToCodeFactoryOutputWindowAsync(string message) Parameters Type Name Description String message The message to be written to the output window. Returns Type Description Task"
+ },
"api/CodeFactory.VisualStudio.IVsFactoryCommand-1.html": {
"href": "api/CodeFactory.VisualStudio.IVsFactoryCommand-1.html",
"title": "Interface IVsFactoryCommand | CodeFactory Guidance",
@@ -797,7 +807,7 @@
"api/CodeFactory.VisualStudio.IVsProject.html": {
"href": "api/CodeFactory.VisualStudio.IVsProject.html",
"title": "Interface IVsProject | CodeFactory Guidance",
- "keywords": "Interface IVsProject Definition of a visual studio project model information. Inherited Members IVsModel.Name IModel.IsLoaded IModel.HasErrors IModel.ModelErrors IModel.ModelType IParent.HasParent IChildren.HasChildren Namespace : CodeFactory.VisualStudio Assembly : CodeFactory.VisualStudio.dll Syntax public interface IVsProject : IVsModel, IModel, IParent, IChildren Properties | Improve this Doc View Source DefaultNamespace The default namespace for the project if it support .net framework or .net core. Otherwise this will be null. Declaration string DefaultNamespace { get; } Property Value Type Description String | Improve this Doc View Source LegacyProjectModel Flag that determines if this visual studio project uses the legacy project model. If so then only basic capabilities and references will be available through code factory. Declaration bool LegacyProjectModel { get; } Property Value Type Description Boolean | Improve this Doc View Source Path The fully qualified path to the project file name. Declaration string Path { get; } Property Value Type Description String | Improve this Doc View Source ProjectLanguages The project languages that are supported in this project. Declaration IReadOnlyList ProjectLanguages { get; } Property Value Type Description IReadOnlyList < ProjectLanguage >"
+ "keywords": "Interface IVsProject Definition of a visual studio project model information. Inherited Members IVsModel.Name IModel.IsLoaded IModel.HasErrors IModel.ModelErrors IModel.ModelType IParent.HasParent IChildren.HasChildren Namespace : CodeFactory.VisualStudio Assembly : CodeFactory.VisualStudio.dll Syntax public interface IVsProject : IVsModel, IModel, IParent, IChildren Properties | Improve this Doc View Source DefaultNamespace The default namespace for the project if it support .net framework or .net core. Otherwise this will be null. Declaration string DefaultNamespace { get; } Property Value Type Description String | Improve this Doc View Source LegacyProjectModel Flag that determines if this visual studio project uses the legacy project model. If so then only basic capabilities and references will be available through code factory. Declaration bool LegacyProjectModel { get; } Property Value Type Description Boolean | Improve this Doc View Source Path The fully qualified path to the project file name. Declaration string Path { get; } Property Value Type Description String | Improve this Doc View Source ProjectLanguages The project languages that are supported in this project. Declaration IReadOnlyList ProjectLanguages { get; } Property Value Type Description IReadOnlyList < ProjectLanguage > | Improve this Doc View Source TargetFrameworks The target frameworks this project supports as output. Declaration IReadOnlyList TargetFrameworks { get; } Property Value Type Description IReadOnlyList < VsProjectFramework >"
},
"api/CodeFactory.VisualStudio.IVsProjectActions.html": {
"href": "api/CodeFactory.VisualStudio.IVsProjectActions.html",
@@ -814,6 +824,11 @@
"title": "Interface IVsProjectFolderActions | CodeFactory Guidance",
"keywords": "Interface IVsProjectFolderActions Visual studio actions that support the IVsProjectFolder model. Namespace : CodeFactory.VisualStudio Assembly : CodeFactory.VisualStudio.dll Syntax public interface IVsProjectFolderActions Methods | Improve this Doc View Source AddDocumentAsync(VsProjectFolder, String, String) Adds a document to the project folder. Declaration Task AddDocumentAsync(VsProjectFolder source, string fileName, string content = null) Parameters Type Name Description VsProjectFolder source The project folder to add the document to. String fileName The file name for the document. This should be the file name only with extension. String content The content to be added to the document once its added. Note, this is an optional parameter. Returns Type Description Task < VsDocument > The model of the created project document. | Improve this Doc View Source AddExistingDocumentAsync(VsProjectFolder, String) Adds an existing document to the project folder. Declaration Task AddExistingDocumentAsync(VsProjectFolder source, string fileName) Parameters Type Name Description VsProjectFolder source The project folder to add the document to. String fileName The file name for the document. This should be the file name only with extension. The file must already be in the project folder. Returns Type Description Task < VsDocument > The model of the created project document. | Improve this Doc View Source AddProjectFolderAsync(VsProjectFolder, String) Adds a new project folder under the current project folder. Declaration Task AddProjectFolderAsync(VsProjectFolder source, string folderName) Parameters Type Name Description VsProjectFolder source The project folder to add to. String folderName The name of the project folder. The project folder name should be the name only no path. Returns Type Description Task < VsProjectFolder > The model for the created project folder. | Improve this Doc View Source DeleteAsync(VsProjectFolder) Deletes the project folder. Declaration Task