Click or drag to resize

Block Class

Represents the body of a BlockStatement or AnonymousMethodBase (containing a sequence of 0 or more CodeObjects).
Inheritance Hierarchy
SystemObject
  Nova.CodeDOMCodeObject
    Nova.CodeDOMBlock

Namespace:  Nova.CodeDOM
Assembly:  Nova.CodeDOM (in Nova.CodeDOM.dll) Version: 7.44.8391.13415
Syntax
C#
public class Block : CodeObject, ICollection<CodeObject>, 
	IEnumerable<CodeObject>, IEnumerable, ICollection

The Block type exposes the following members.

Constructors
Properties
  NameDescription
Public property_AsString
This property is just to make debugging easier.
(Inherited from CodeObject.)
Public propertyAnnotations
Annotations (comments, attributes, directives, messages) associated with the current code object.
(Inherited from CodeObject.)
Public propertyColumnNumber
The column number associated with the CodeObject (if any, 0 if none).
(Inherited from CodeObject.)
Public propertyComment
The comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyCount
The number of code objects in the Block.
Public propertyDocComment
The documentation comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyEndColumnNumber
The ending column number associated with the Block if parsed from or written to text form. This will be the column of the closing '}' if any, or of the last token if there are no braces, which is usually the ';' of the last statement.
Public propertyEndLineNumber
The ending line number associated with the Block if parsed from or written to text form. This will be the line of the closing '}' if any, or of the last token if there are no braces, which is usually the ';' of the last statement.
Public propertyEndNewLines
The number of newlines preceding the closing '}' (0 to N).
Public propertyEOLComment
The End-Of-Line comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyHasAnnotations
True if the code object has any annotations.
(Inherited from CodeObject.)
Public propertyHasAttributes
True if the code object has any attributes.
(Inherited from CodeObject.)
Public propertyHasBraces
True if the Block is delimited by braces.
Public propertyHasComments
True if the code object has any comments of any kind.
(Inherited from CodeObject.)
Public propertyHasCompilerDirectives
True if the code object has any compiler directive annotations.
(Inherited from CodeObject.)
Public propertyHasDocComments
True if the code object has any documentation comments.
(Inherited from CodeObject.)
Public propertyHasEOLComments
True if the code object has any EOL comments.
(Inherited from CodeObject.)
Public propertyHasEOLOrPostAnnotations
True if the code object has any EOL or Postfix annotations.
(Inherited from CodeObject.)
Public propertyHasErrors
True if the code object has any error messages.
(Inherited from CodeObject.)
Public propertyHasFirstOnLineAnnotations
True if the code object has any annotations on separate lines.
(Inherited from CodeObject.)
Public propertyHasInfixComments
True if the code object has any Infix comments.
(Inherited from CodeObject.)
Public propertyHasMessages
True if the code object has any generated messages.
(Inherited from CodeObject.)
Public propertyHasNoIndentation
Determines if the code object has no indentation.
(Inherited from CodeObject.)
Public propertyHasNonEOLComments
True if the code object has any regular (non-doc) preceding (non-EOL, non-Infix, non-Postfix) comments.
(Inherited from CodeObject.)
Public propertyHasPostAnnotations
True if the code object has any postfix annotations.
(Inherited from CodeObject.)
Public propertyHasTerminator
Determines if the code object has a terminator character.
(Overrides CodeObjectHasTerminator.)
Public propertyHiddenRef
Any hidden reference to another CodeObject.
(Inherited from CodeObject.)
Public propertyInfixComment
The infix comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyInfixEOLComment
The "Infix" End-Of-Line comment for the Initializer (if any) - appears after the open brace.
Public propertyIsFirstOnLine
Determines if the code object appears as the first item on a line.
(Overrides CodeObjectIsFirstOnLine.)
Public propertyIsFirstOnLineDefault
True if the code object defaults to starting on a new line.
(Overrides CodeObjectIsFirstOnLineDefault.)
Public propertyIsGenerated
Determines if the code object is generated.
(Inherited from CodeObject.)
Public propertyIsGroupingSet
Determines if the 'grouping' (has parens or braces) status has been set.
(Inherited from CodeObject.)
Public propertyIsNewLinesSet
Determines if the newline count has been set on the code object.
(Inherited from CodeObject.)
Public propertyIsReadOnly
Always false.
Public propertyIsRenderable
True if the CodeObject is renderable.
(Inherited from CodeObject.)
Public propertyIsSingleLine
Determines if the code object only requires a single line for display.
(Overrides CodeObjectIsSingleLine.)
Public propertyIsSingleLineDefault
True if the code object only requires a single line for display by default.
(Overrides CodeObjectIsSingleLineDefault.)
Public propertyIsSynchronized
True if access to the ICollection is synchronized.
Public propertyItem
Get the child CodeObject at the specified index.
Public propertyLast
Get the last CodeObject in the Block.
Public propertyLineNumber
The line number associated with the CodeObject (if any, 0 if none).
(Inherited from CodeObject.)
Public propertyNewLines
The number of newlines preceding the opening '{' (0 or 1 only - setting a higher value is ignored).
(Overrides CodeObjectNewLines.)
Public propertyParent
The parent CodeObject.
(Overrides CodeObjectParent.)
Public propertyPostfixComment
The postfix comment for the code object (if any).
(Inherited from CodeObject.)
Public propertySyncRoot
Gets an object that can be used to synchronize access to the ICollection.
Top
Methods
  NameDescription
Public methodAccept
Accept the specified visitor object for the current code object and it's children.
(Overrides CodeObjectAccept(IVisitor).)
Public methodAcceptAnnotations(IVisitor)
Accept the specified visitor object for all regular (non-EOL, non-Infix, non-Postfix) annotations (comments, attributes, compiler directives).
(Inherited from CodeObject.)
Public methodAcceptAnnotations(IVisitor, AnnotationFlags)
Accept the specified visitor object for all specified Infix or Postfix annotations (comments, compiler directives).
(Inherited from CodeObject.)
Public methodAcceptEOLComments
Accept the specified visitor object for all EOL comments.
(Inherited from CodeObject.)
Public methodAcceptInfixComments
Accept the specified visitor object for all Infix comments.
(Inherited from CodeObject.)
Public methodAcceptInfixEOLComments
Accept the specified visitor object for all Infix EOL comments.
(Inherited from CodeObject.)
Public methodAdd(CodeObject)
Add a code object to the Block.
Public methodAdd(CodeObject)
Add multiple code objects to the Block.
Protected methodAddInsertFormattingCheck
Protected methodAddInternal
Protected methodAddInternalNoFormatting
Protected methodAddNamedMember
Public methodAddRange
Add a collection of code objects to the Block.
Protected methodAddTrailingComments
Add any trailing Comment objects on the specified token to the Block.
Public methodAssociateCommentWhenParsing
Determine if the specified comment should be associated with the current code object during parsing.
(Inherited from CodeObject.)
Public methodAsString
Render the entire code object as a string, using LFs for newlines.
(Inherited from CodeObject.)
Public methodAsText
Convert the code object to text with a trailing newline, and using CR/LF pairs for newlines (file format).
(Inherited from CodeObject.)
Public methodAsText(CodeWriter, CodeObjectRenderFlags) (Overrides CodeObjectAsText(CodeWriter, CodeObjectRenderFlags).)
Public methodAsText(CodeObjectRenderFlags, Boolean, StackCodeWriterAlignmentState)
Convert the code object to text using the specified flags and format (file or string).
(Inherited from CodeObject.)
Protected methodAsTextAfter (Inherited from CodeObject.)
Public methodAsTextAnnotations(CodeWriter, CodeObjectRenderFlags)
Render all regular (non-EOL, non-Infix, non-Postfix, non-Message) annotations (comments, attributes, compiler directives).
(Inherited from CodeObject.)
Public methodAsTextAnnotations(CodeWriter, AnnotationFlags, CodeObjectRenderFlags)
Render all specified Infix or Postfix annotations (comments, compiler directives).
(Inherited from CodeObject.)
Protected methodAsTextBefore (Inherited from CodeObject.)
Public methodAsTextEOLComments
Render all EOL comments.
(Inherited from CodeObject.)
Protected methodAsTextEvaluatedType (Inherited from CodeObject.)
Public methodAsTextInfixComments
Render all Infix comments with the specified mask.
(Inherited from CodeObject.)
Public methodAsTextInfixEOLComments
Render all Infix EOL comments.
(Inherited from CodeObject.)
Public methodAsTextLeftMostAnnotations
Render all regular annotations on the current object, or the left most binary operator.
(Inherited from CodeObject.)
Public methodAsTextLength
Determine the length of the code object if converted to a string using the specified flags.
(Inherited from CodeObject.)
Public methodAttachAnnotation(Annotation, Boolean) (Inherited from CodeObject.)
Public methodAttachAnnotation(Annotation, AnnotationFlags, Boolean)
Attach an Annotation to the CodeObject at the specified position.
(Inherited from CodeObject.)
Public methodAttachComment
Create a comment object and attach it to the code object.
(Inherited from CodeObject.)
Public methodAttachEOLComment
Create an EOL comment object and attach it to the code object.
(Inherited from CodeObject.)
Public methodAttachMessage
Create a message and attach it to the code object.
(Inherited from CodeObject.)
Public methodCalculateMetrics
Calculate metrics for this code object and its children.
(Inherited from CodeObject.)
Protected methodCheckForAlignment
Check for alignment of any EOL comments.
(Inherited from CodeObject.)
Public methodClear
Clear all members from the Block.
Public methodClone
Deep-clone the code object.
(Overrides CodeObjectClone.)
Protected methodCloneField(Object, Object)
Clone a field of a code object, including setting the parent.
(Inherited from CodeObject.)
Protected methodCloneFieldT(T, T)
Clone a field of a code object, including setting the parent.
(Inherited from CodeObject.)
Public methodContains
Check if the Block contains the specified CodeObject.
Public methodCopyFormatting
Copy formatting from another code object.
(Inherited from CodeObject.)
Public methodCopyTo(Array, Int32)
Copy the code objects in the block to the specified array, starting at the specified offset.
Public methodCopyTo(CodeObject, Int32)
Copy the code objects in the block to the specified array, starting at the specified offset.
Public methodCreateAnnotations
Create the list of child Annotations, or return the existing one.
(Inherited from CodeObject.)
Public methodCreateRef
Create a reference to the CodeObject.
(Inherited from CodeObject.)
Protected methodDefaultFormat
Default format the code object.
(Inherited from CodeObject.)
Protected methodDefaultFormatField
Default format the specified child field code object.
(Inherited from CodeObject.)
Public methodDefaultNewLines
Determine a default of 1 or 2 newlines when adding items to a Block.
(Inherited from CodeObject.)
Public methodDispose
Dispose the CodeObject.
(Inherited from CodeObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluateTypeOrNamespace
Evaluate the type or namespace associated with the code object.
(Inherited from CodeObject.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFind(String)
Enumerate all children with the specified name.
Public methodFindT
Enumerate all children of type T.
Public methodFindT(String)
Enumerate all children with the specified name and type.
Public methodFindChildren(String)
Find children with the specified name.
Public methodFindChildrenT(ICollectionT)
Find children of the specified type T, adding them to the specified results collection.
Public methodFindChildrenT(String, NamedObjectGroup)
Find children with the specified name having type T, adding them to the specified results collection.
Public methodFindFirstT
Find the first child object of type T.
Public methodFindFirstT(String)
Find the first child object with the specified name and type.
Public methodFindIndexOf
Find the index of the specified CodeObject in the Block.
Public methodFindParentT
Find the parent object of the specified type.
(Inherited from CodeObject.)
Public methodFindParentMethod
Find the parent method (or anonymous method or lambda) of the current code object.
(Inherited from CodeObject.)
Public methodFindParentMethodOrType
Find the parent method (or anonymous method or lambda) or type of the current code object.
(Inherited from CodeObject.)
Protected methodFlushUnrecognized
Protected methodFlushUnused
Flush unused objects in the parser into the Block.
Public methodGetAllChildrenT
Get an enumerator for all children objects of type T in the CodeObject and in any child CodeObjects (recursively).
(Inherited from CodeObject.)
Public methodGetAttribute
Returns the first attribute expression (Call or ConstructorRef) with the specified name on the CodeObject.
(Inherited from CodeObject.)
Public methodGetComment
Get the comment that satisfies the specified predicate.
(Inherited from CodeObject.)
Public methodGetDescription
Get a short text description of the CodeObject. This is generally the shortest text representation that uniquely identifies objects, even if they have the same name, for example: type or return type, name, type parameters, parameters.
(Inherited from CodeObject.)
Public methodGetDocSummary
Returns the DocSummary documentation comment, or null if none exists.
(Inherited from CodeObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIndentLevel
Get the indent level of this object.
(Inherited from CodeObject.)
Public methodGetIndentSpaceCount
Get the current indent in spaces.
(Inherited from CodeObject.)
Public methodGetInferredType
Determine the type of an inferred ('var') type.
(Inherited from CodeObject.)
Public methodGetNamespace
Get the Namespace for this CodeObject.
(Inherited from CodeObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeRef
Get a TypeRef for the type with the specified full name, with caching (generally used for System types).
(Inherited from CodeObject.)
Public methodGetWorstMessageType
Get the type of the worst attached message.
(Inherited from CodeObject.)
Protected methodHasAnnotationT (Inherited from CodeObject.)
Public methodHasAttribute
Returns true if the attribute with the specified name exists on the object, otherwise false.
(Inherited from CodeObject.)
Public methodHasUnresolvedRef
Returns true if the code object is an UnresolvedRef or has any UnresolvedRef children.
(Overrides CodeObjectHasUnresolvedRef.)
Public methodInsert
Insert a code object into the block at the specified index.
Protected methodInsertInternalNoFormatting
Protected methodIsChildIndented
Returns true if the specified child object is indented from the parent.
(Inherited from CodeObject.)
Protected methodIsChildPrefix
Returns true if the specified child object is prefixed to the current object.
(Inherited from CodeObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveAllComments
Move all (regular or EOL) comments from the specified token to the current code object, converting any EOL comments to regular comments (which will be rendered inline if necessary).
(Inherited from CodeObject.)
Public methodMoveAnnotations
Move any annotations from the specified location to the specified destination location.
(Inherited from CodeObject.)
Public methodMoveComments(Token)
Move any non-EOL comments from the specified token to the current code object.
(Inherited from CodeObject.)
Public methodMoveComments(Token, Boolean)
Move any non-EOL comments from the specified token to the current code object.
(Inherited from CodeObject.)
Public methodMoveCommentsAsPost
Move any non-EOL comments from the specified token to the current code object as Post comments.
(Inherited from CodeObject.)
Public methodMoveEOLAndPostAnnotations
Move any EOL or Postfix annotations from the specified code object to the current code object.
(Inherited from CodeObject.)
Public methodMoveEOLComment(CodeObject)
Move any EOL comment from the specified code object to the current code object.
(Inherited from CodeObject.)
Public methodMoveEOLComment(Token)
Move any EOL comment from the specified token to the current code object.
(Inherited from CodeObject.)
Public methodMoveEOLComment(Token, Boolean, Boolean)
Move any EOL comment from the specified token to the current code object.
(Inherited from CodeObject.)
Public methodMoveEOLCommentAsInfix
Move any EOL comment from the specified token to the current code object as an Infix EOL comment.
(Inherited from CodeObject.)
Public methodMoveFormatting(CodeObject)
Move formatting from the specified code object to the current object.
(Inherited from CodeObject.)
Public methodMoveFormatting(Token)
Move formatting from the specified token to the current object.
(Inherited from CodeObject.)
Public methodMovePrefixAnnotationsAs
Move any prefix annotations on the specified code object to the current code object as the specified type of annotation.
(Inherited from CodeObject.)
Protected methodNotifyListedAnnotationAdded
Propagate the listed annotation to the parent CodeUnit and above.
(Inherited from CodeObject.)
Protected methodNotifyListedAnnotationRemoved
Remove the listed annotation from the parent CodeUnit and above.
(Inherited from CodeObject.)
Protected methodObjectCountChanged
Protected methodParseAnnotations(Parser, CodeObject)
Parse annotations - specifically, compiler directives around things such as TypeParameters or ParameterDecls.
(Inherited from CodeObject.)
Protected methodParseAnnotations(Parser, CodeObject, Boolean, Boolean)
Parse any comments, attributes, compiler directives.
(Inherited from CodeObject.)
Public methodStatic memberParseCompilerDirectives
Parse any compiler directives between a statement header and body (or base type list, constructor initializer, or type constraints). Also used to parse any "open" conditional directives if 'includeAll' is false.
Protected methodParseExpectedToken
Parse the specified expected token, attaching a parse error to the current object if it doesn't exist.
(Inherited from CodeObject.)
Public methodParseExpressionAsBlock
Parse an Expression into the Block.
Protected methodParseUnusedAnnotations
Parse annotations from the Unused list.
(Inherited from CodeObject.)
Protected methodPostProcessComment
Post-process the specified comment object at the specified index, associating with the following object if applicable.
Public methodRebuildDictionary
Re-build the internal dictionary of named code objects in the Block.
Public methodRemove
Remove the specified CodeObject from the Block.
Public methodRemoveAll
Remove all code objects from the Block.
Public methodRemoveAllAnnotationsT
Remove all annotations of the specified type from this object.
(Inherited from CodeObject.)
Public methodRemoveAllAnnotationsWhereT
Remove all annotations from this object where the specified predicate is true.
(Inherited from CodeObject.)
Public methodRemoveAllMessages
Remove all messages from this object, or optionally only from the specified source.
(Inherited from CodeObject.)
Public methodRemoveAt
Remove the CodeObject at the specified index from the Block.
Public methodRemoveAttribute
Remove the attribute expression with the specified name.
(Inherited from CodeObject.)
Protected methodRemoveInternal
Protected methodRemoveNamedMember
Public methodReplace
Replace the specified CodeObject with a new one.
Public methodResolve(ResolveFlags)
Resolve all child symbolic references.
(Inherited from CodeObject.)
Public methodResolve(ResolveCategory, ResolveFlags)
Resolve all child symbolic references, using the specified ResolveCategory and ResolveFlags.
(Overrides CodeObjectResolve(ResolveCategory, ResolveFlags).)
Public methodResolveAttributes
Resolve any attached attributes.
(Inherited from CodeObject.)
Public methodResolveDocComments
Resolve any references in attached documentation comments.
(Inherited from CodeObject.)
Public methodResolveExtensionMethod
Resolve an extension method with the specified name.
Public methodResolveGotoTargetUp
Resolve child code objects that match the specified name are valid goto targets, moving up the tree until a complete match is found.
(Overrides CodeObjectResolveGotoTargetUp(String, Resolver).)
Public methodResolveIndexerRef
Resolve indexers.
Public methodResolveRef
Resolve child code objects that match the specified name.
Public methodResolveRefUp
Resolve child code objects that match the specified name, moving up the tree until a complete match is found.
(Inherited from CodeObject.)
Public methodResolveRefUpSkipMethodBody
Similar to ResolveRefUp(String, Resolver), but skips trying to resolve the symbol in the body or parameters of a method (used for resolving parameter types).
(Inherited from CodeObject.)
Protected methodSetEndLineCol
Set the ending line and column numbers to those in the specified token.
Protected methodSetField(Object, Object, Boolean)
Set a field of a code object, including setting the parent, and optional formatting.
(Inherited from CodeObject.)
Protected methodSetFieldT(ChildListT, ChildListT)
Set a ChildList collection field of a code object, including setting the parent.
(Inherited from CodeObject.)
Protected methodSetFieldT(T, T, Boolean)
Set a field of a code object, including setting the parent, and optional formatting.
(Inherited from CodeObject.)
Protected methodSetFormatFlag (Inherited from CodeObject.)
Protected methodSetLineCol(CodeObject)
Set the line and column numbers to those in the specified CodeObject.
(Inherited from CodeObject.)
Protected methodSetLineCol(Token)
Set the line and column numbers to those in the specified token.
(Inherited from CodeObject.)
Public methodSetNewLines
Special method to set the newline count without setting the NewLinesSet flag.
(Inherited from CodeObject.)
Protected methodSetStartLineCol
Set the starting line and column numbers to those in the specified token (used by some code objects with prefixes such as modifiers).
(Inherited from CodeObject.)
Public methodStatic memberSkipParsingBlock
Skip parsing a brace-delimited Block.
Public methodToString
Render the type of the code object and its description as a string.
(Inherited from CodeObject.)
Public methodUpdateAllDeclExpressions
Recursively update the dictionary of names in the specified Block by either adding or removing (as specified by the 2nd parameter) all appropriate nested INamedCodeObjects expressions in the current CodeObject tree (specifically implemented for LocalDeclExpr expression objects).
(Inherited from CodeObject.)
Protected methodUpdateEndLineCol
Update the ending line and column numbers according to the current positions in the CodeWriter, if the UpdateLineCol flag is set.
Protected methodUpdateLineCol
Update the line and column numbers according to the current positions in the CodeWriter, if the UpdateLineCol flag is set.
(Inherited from CodeObject.)
Top
Fields
  NameDescription
Protected field_annotations
Any Annotations (Comments, DocComments, Attributes, or Messages) associated with the CodeObject (null if none).
(Inherited from CodeObject.)
Protected field_codeObjects
Child CodeObjects - the Parent of this collection will be the Block's Parent, so that the Parent of all child objects will be the Block's Parent, not the Block.
Protected field_columnNumber
The starting column number associated with the CodeObject if parsed from or written to text form.
(Inherited from CodeObject.)
Protected field_endColumnNumber
The ending column number associated with the Block if parsed from or written to text form. This will be the column of the closing '}' if any, or of the last token if there are no braces, which is usually the ';' of the last statement.
Protected field_endLineNumber
The ending line number associated with the Block if parsed from or written to text form. This will be the line of the closing '}' if any, or of the last token if there are no braces, which is usually the ';' of the last statement.
Protected field_formatFlags
Formatting flags - for line feeds, braces, etc.
(Inherited from CodeObject.)
Protected field_lineNumber
The starting line number associated with the CodeObject if parsed from or written to text form.
(Inherited from CodeObject.)
Protected field_namedMembers
Dictionary of named members in the block (LocalDecls, Labels, SwitchItems, nested LocalDeclExpr expressions, or if the block's parent is a TypeDecl then the various named members).
Protected field_parent
The parent CodeObject.
(Inherited from CodeObject.)
Public fieldStatic memberAlignComments
Determines if EOL comments on consecutive lines are aligned vertically.
Public fieldStatic memberParseTokenEnd
The token used to parse the end of a Block.
Public fieldStatic memberParseTokenStart
The token used to parse the start of a Block.
Top
Extension Methods
  NameDescription
Public Extension MethodIsEmpty
Check if the specified collection is empty or null.
(Defined by CollectionUtil.)
Public Extension MethodNNCount
Get the count of the specified collection, or 0 if it's null.
(Defined by CollectionUtil.)
Public Extension MethodNotEmpty
Check if the specified collection is empty or null.
(Defined by CollectionUtil.)
Public Extension MethodToString
Format the specified collection into a single string using the specified separating string to separate each item. Null items are converted to empty strings.
(Defined by StringUtil.)
Top
Remarks
Blocks are special in that their children's Parent references link directly to the parent of the Block, in order to simplify various logic.
See Also