Interface ICsContainer

The base implementation all container type models must implement in C#.

Inherited Members

ICsModel.LoadedFromSource

ICsModel.Language

ICsModel.ModelType

ICsModel.SourceDocument

ICsModel.GetModel<T>(string)

ICsModel.GetModel(string)

IModelStatus.IsLoaded

IModelStatus.HasErrors

IModelStatus.GetErrors()

ISourceFiles.SourceFiles

ISourceFiles.ModelSourceFile

ICsAttributes.HasAttributes

ICsAttributes.Attributes

IDocumentation.HasDocumentation

IDocumentation.Documentation

IDocumentation.AddBeforeDocsAsync(string)

IDocumentation.AddAfterDocsAsync(string)

IDocumentation.ReplaceDocsAsync(string)

IDocumentation.DeleteDocsAsync()

ICsGeneric.IsGeneric

ICsGeneric.GenericParameters

ICsGeneric.HasStrongTypesInGenerics

ICsGeneric.GenericTypes

IParent.Parent

ILookup.LookupPath

Namespace: CodeFactory.WinVs.Models.CSharp

Assembly: CodeFactory.WinVs.dll

Syntax

public interface ICsContainer : ICsModel, IModelStatus, ISourceFiles, ICsAttributes, IDocumentation, ICsGeneric, IParent, ILookup

Properties

ContainerType

The type of container model that has been implemented.

Declaration

CsContainerType ContainerType { get; }

Property Value

Type	Description
CsContainerType

Events

Enumeration of the events assigned to this container. If HasEvents is false this will be null.

Declaration

IReadOnlyList<CsEvent> Events { get; }

Property Value

Type	Description
IReadOnlyList<CsEvent>

InheritedInterfaces

List of the interfaces that are inherited by this container.

Declaration

IReadOnlyList<CsInterface> InheritedInterfaces { get; }

Property Value

Type	Description
IReadOnlyList<CsInterface>

Members

List of the members that are implemented in this container.

Declaration

IReadOnlyList<CsMember> Members { get; }

Property Value

Type	Description
IReadOnlyList<CsMember>

Methods

List of the methods that are implemented in this container.

Declaration

IReadOnlyList<CsMethod> Methods { get; }

Property Value

Type	Description
IReadOnlyList<CsMethod>

Name

The name of the container.

Declaration

string Name { get; }

Property Value

Type	Description
string

Namespace

The namespace the container objects belongs to.

Declaration

string Namespace { get; }

Property Value

Type	Description
string

Properties

List of the properties that are implemented in this container.

Declaration

IReadOnlyList<CsProperty> Properties { get; }

Property Value

Type	Description
IReadOnlyList<CsProperty>

Security

The security scope assigned to the container.

Declaration

CsSecurity Security { get; }

Property Value

Type	Description
CsSecurity

Methods

AddAfterAsync(string)

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

Declaration

Task<CsSource> AddAfterAsync(string sourceCode)

Parameters

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

Returns

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

Exceptions

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

AddAfterAsync(string, string)

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

Declaration

Task<CsSource> AddAfterAsync(string sourceDocument, string sourceCode)

Parameters

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

Returns

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

Exceptions

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

AddBeforeAsync(string)

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

Declaration

Task<CsSource> AddBeforeAsync(string sourceCode)

Parameters

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

Returns

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

Exceptions

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

AddBeforeAsync(string, bool)

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

Declaration

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

Parameters

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

Returns

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

Exceptions

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

AddBeforeAsync(string, string)

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

Declaration

Task<CsSource> AddBeforeAsync(string sourceDocument, string sourceCode)

Parameters

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

Returns

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

Exceptions

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

AddToBeginningAsync(string)

Adds the source code inside of the container at the beginning of where members are defined in the container.

Declaration

Task<CsSource> AddToBeginningAsync(string sourceCode)

Parameters

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

Returns

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

AddToBeginningAsync(string, string)

Adds the source code inside of the container at the beginning of where members are defined in the container.

Declaration

Task<CsSource> AddToBeginningAsync(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 document.

Returns

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

AddToEndAsync(string)

Adds the source code inside of the container at the end of where members are defined in the container.

Declaration

Task<CsSource> AddToEndAsync(string sourceCode)

Parameters

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

Returns

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

AddToEndAsync(string, string)

Adds the source code inside of the container at the end of where members are defined in the container.

Declaration

Task<CsSource> AddToEndAsync(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 document.

Returns

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

DeleteAsync()

Deletes the definition of the container from the source document.

Declaration

Task<CsSource> DeleteAsync()

Returns

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

Exceptions

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

DeleteAsync(string)

Deletes the definition of the container from the source document.

Declaration

Task<CsSource> DeleteAsync(string sourceDocument)

Parameters

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

Returns

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

Exceptions

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

GetBodySourceLocationAsync()

Gets the starting and ending locations of the body located in the container.

Declaration

Task<ISourceLocation> GetBodySourceLocationAsync()

Returns

Type	Description
Task<ISourceLocation>	The source location in the container.

Exceptions

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

GetBodySourceLocationAsync(string)

Gets the starting and ending locations of the body located in the container.

Declaration

Task<ISourceLocation> GetBodySourceLocationAsync(string sourceDocument)

Parameters

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

Returns

Type	Description
Task<ISourceLocation>	The source location in the container.

Exceptions

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

GetBodySyntaxAsync()

The source code syntax that is stored in the body of the container model. This will be null if the container was not loaded from source code.

Declaration

Task<string> GetBodySyntaxAsync()

Returns

Type	Description
Task<string>

GetSourceLocationAsync()

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

Declaration

Task<ISourceLocation> GetSourceLocationAsync()

Returns

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

Exceptions

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

GetSourceLocationAsync(string)

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

Declaration

Task<ISourceLocation> GetSourceLocationAsync(string sourceDocument)

Parameters

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

Returns

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

Exceptions

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

ReplaceAsync(string)

Replaces the current container with the provided source code.

Declaration

Task<CsSource> ReplaceAsync(string sourceCode)

Parameters

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

Returns

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

Exceptions

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

ReplaceAsync(string, string)

Replaces the current container with the provided source code.

Declaration

Task<CsSource> ReplaceAsync(string sourceDocument, string sourceCode)

Parameters

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

Returns

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

Exceptions

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

Extension Methods

GenerateCSharpDocumentationExtensions.GenerateCSharpXmlDocumentation(IDocumentation, int)

GenerateCSharpDocumentationExtensions.GenerateCSharpXmlDocumentationEnumerator(IDocumentation)