Interface ICsEnum

Data model that provides information on an enumeration.

Inherited Members

ICsNestedModel.NestedType

ICsNestedModel.IsNested

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()

IParent.Parent

ILookup.LookupPath

Namespace: CodeFactory.WinVs.Models.CSharp

Assembly: CodeFactory.WinVs.dll

Syntax

public interface ICsEnum : ICsNestedModel, ICsModel, IModelStatus, ISourceFiles, ICsAttributes, IDocumentation, IParent, ILookup

Properties

Name

The name of the enumeration.

Declaration

string Name { get; }

Property Value

Type	Description
string

Namespace

The namespace the enumeration belongs to.

Declaration

string Namespace { get; }

Property Value

Type	Description
string

Security

The security scope assigned to the enumeration.

Declaration

CsSecurity Security { get; }

Property Value

Type	Description
CsSecurity

Values

List of the enumeration values implemented in this enumeration.

Declaration

IReadOnlyList<CsEnumValue> Values { get; }

Property Value

Type	Description
IReadOnlyList<CsEnumValue>

Methods

AddAfterAsync(string)

Adds the source code directly after the definition of the ICsEnumin 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 ICsEnumin the target document.

Declaration

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

Parameters

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

Returns

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

Exceptions

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

AddBeforeAsync(string)

Adds the source code directly before the definition of the ICsEnumin 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 ICsEnumin 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 enum definition not before the documentation or attributes that are assigned.

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 ICsEnumin the target document.

Declaration

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

Parameters

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

Returns

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

Exceptions

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

AddToBeginningAsync(string)

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

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.

AddToEndAsync(string)

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

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.

DeleteAsync()

Deletes the definition of the enumeration from the source document.

Declaration

Task<CsSource> DeleteAsync()

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the enumeration 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 enumeration from the source document.

Declaration

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

Parameters

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

Returns

Type	Description
Task<CsSource>	A newly loaded copy of the ICsSource model after the enumeration 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 enum.

Declaration

Task<ISourceLocation> GetBodySourceLocationAsync()

Returns

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

Exceptions

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

GetSourceLocationAsync()

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

Declaration

Task<ISourceLocation> GetSourceLocationAsync()

Returns

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

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 enumeration is located.

Declaration

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

Parameters

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

Returns

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

Exceptions

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

ReplaceAsync(string)

Replaces the current enumeration 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 enumeration with the provided source code.

Declaration

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

Parameters

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

Returns

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

Exceptions

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

Extension Methods

GenerateCSharpDocumentationExtensions.GenerateCSharpXmlDocumentation(IDocumentation, int)

GenerateCSharpDocumentationExtensions.GenerateCSharpXmlDocumentationEnumerator(IDocumentation)