FindByText Class

Represents a search of a CodeDOM tree for all objects containing certain text, including the search parameters and results.

Inheritance Hierarchy

SystemObject
Nova.AnalysisFindByText

Namespace: Nova.Analysis
Assembly: Nova.CodeDOM (in Nova.CodeDOM.dll) Version: 7.44.8391.13415

Syntax

Copy

public class FindByText : IVisitor

The FindByText type exposes the following members.

Constructors

	Name	Description
	FindByText	Create an instance that finds the specified text string using the specified parameters.

Top

Properties

	Name	Description
	Results	The results of the search.
	VisitHiddenRefs	Returns false for FindByText, because we don't want to match hidden text.

Top

Methods

	Name	Description
	AddResult
	Check(INamedCodeObject)	Check if the INamedCodeObject is a match.
	Check(String, CodeObject)	Check if the CodeObject with the specified text representation is a match.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Find	Perform the search operation.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	(Overrides ObjectToString.)
	Visit(Alias)	Visit an Alias statement.
	Visit(AnonymousMethodBase)	Visit an AnonymousMethodBase expression (common base of LambdaExpression, AnonymousMethod).
	Visit(ArgumentsOperator)	Visit an ArgumentsOperator operator (common base of Call, Index, NewOperator).
	Visit(Attribute)	Visit an Attribute annotation.
	Visit(BinaryOperator)	Visit a BinaryOperator operator (common base of BinaryArithmeticOperator, BinaryBitwiseOperator, BinaryBooleanOperator, BinaryShiftOperator, Assignment, As, Dot, IfNullThen, Lookup, PointerMember).
	Visit(Block)	Visit a Block body of a BlockStatement - this should rarely be used, since all members of the Block will be visited separately.
	Visit(BlockDecl)	Visit a BlockDecl statement.
	Visit(Break)	Visit a Break statement.
	Visit(Catch)	Visit a Catch statement.
	Visit(CheckedBlock)	Visit a CheckedBlock statement.
	Visit(CodeUnit)	Visit a CodeUnit.
	Visit(Comment)	Visit a Comment annotation.
	Visit(CompilerDirective)	Visit a CompilerDirective annotation (common base of ConditionalDirective, MessageDirective, SymbolDirective, PragmaDirective, LineDirective).
	Visit(Conditional)	Visit a Conditional operator.
	Visit(ConstraintClause)	Visit a ConstraintClause.
	Visit(Continue)	Visit a Continue statement.
	Visit(DocComment)	Visit a DocComment annotation (also DocText, DocCodeRefBase, DocNameBase, DocB, DocC, DocCode, DocCDATA, DocExample, DocI, DocInclude, DocPara, DocRemarks, DocSummary, DocTag, DocValue, DocList, DocListHeader, DocListItem, DocListDescription, DocListTerm).
	Visit(Else)	Visit an Else statement.
	Visit(EnumMemberDecl)	Visit an EnumMemberDecl statement.
	Visit(ExternAlias)	Visit an ExternAlias statement.
	Visit(FieldDecl)	Visit a FieldDecl statement (also MultiFieldDecl, FixedSizeBufferDecl, MultiFixedSizeBufferDecl).
	Visit(Finally)	Visit a Finally statement.
	Visit(Fixed)	Visit a Fixed statement.
	Visit(For)	Visit a For statement.
	Visit(ForEach)	Visit a ForEach statement.
	Visit(Goto)	Visit a Goto statement.
	Visit(IfBase)	Visit an IfBase statement (common base of If, ElseIf).
	Visit(Initializer)	Visit an Initializer expression.
	Visit(Label)	Visit a Label statement.
	Visit(Literal)	Visit a Literal expression.
	Visit(LocalDecl)	Visit a LocalDecl statement (also MultiLocalDecl).
	Visit(LocalDeclExpr)	Visit an LocalDeclExpr expression.
	Visit(Lock)	Visit a Lock statement.
	Visit(Message)	Visit a Message annotation.
	Visit(MethodDeclBase)	Visit a MethodDeclBase statement (common base of MethodDecl, GenericMethodDecl, ConstructorDecl, DestructorDecl, GetterDecl, SetterDecl, AdderDecl, RemoverDecl, OperatorDecl, BooleanOperatorDecl, ConversionOperatorDecl).
	Visit(NamedArgument)	Visit a NamedArgument expression.
	Visit(NamespaceDecl)	Visit a NamespaceDecl statement (does NOT include CodeUnits).
	Visit(Ordering)	Visit an Ordering expression (children of OrderByClause).
	Visit(ParameterDecl)	Visit a ParameterDecl statement (also ValueParameterDecl, ArgListParameterDecl).
	Visit(Project)	Visit a Project.
	Visit(PropertyDeclBase)	Visit a PropertyDeclBase statement (common base of PropertyDecl, IndexerDecl, EventDecl).
	Visit(QueryBodyBase)	Visit a QueryBodyBase expression (common base of QueryExpression, QueryContinuation).
	Visit(QueryClauseBase)	Visit a QueryClauseBase (common base of FromClause, LetClause, JoinClause, WhereClause, OrderByClause, SelectClause, GroupClause).
	Visit(Return)	Visit a Return statement.
	Visit(SingleArgumentOperator)	Visit a SingleArgumentOperator operator (common base of Ref, Out, Checked, Unchecked, TypeOf, SizeOf, DefaultValue).
	Visit(Switch)	Visit a Switch statement.
	Visit(SwitchItem)	Visit a SwitchItem statement (common base of Case, Default).
	Visit(SymbolicRef)	Visit a SymbolicRef expression (common base of NamespaceRef, TypeRefBase [common base of TypeRef, MethodRef, UnresolvedRef], VariableRef, SelfRef, GotoTargetRef, ExternAliasRef, and DirectiveSymbolRef).
	Visit(Throw)	Visit a Throw statement.
	Visit(ThrowExpr)	Visit an ThrowExpr expression.
	Visit(Try)	Visit a Try statement.
	Visit(TypeDecl)	Visit a TypeDecl statement (common base of ClassDecl, StructDecl, InterfaceDecl, EnumDecl, DelegateDecl).
	Visit(TypeParameter)	Visit a TypeParameter.
	Visit(TypeParameterConstraint)	Visit a TypeParameterConstraint (common base of ClassConstraint, StructConstraint, NewConstraint, TypeConstraint).
	Visit(UnaryOperator)	Visit an UnaryOperator operator (common base of AddressOf, Cast, Complement, Decrement, False, Increment, Negative, Not, PointerIndirection, Positive, True, PostIncrement, PostDecrement).
	Visit(UncheckedBlock)	Visit an UncheckedBlock statement.
	Visit(Unrecognized)	Visit an Unrecognized expression.
	Visit(Unsafe)	Visit an Unsafe statement.
	Visit(Using)	Visit a Using statement.
	Visit(UsingDirective)	Visit a UsingDirective statement.
	Visit(While)	Visit a While statement.
	Visit(YieldStatement)	Visit a YieldStatement statement.
	VisitT(ChildListT)	Visit a ChildListT collection - this should rarely be used, since all members of the list will be visited separately.

Top

Fields

	Name	Description
	_currentCodeUnit
	_results
	MatchCase	True if the search is case-sensitive.
	MatchComments	True if Comments and DocComments should be matched.
	MatchDeclarations	True if declarations (INamedCodeObjects) should be matched.
	MatchLiterals	True if Literals should be matched.
	MatchMessages	True if Messages should be matched.
	MatchReferences	True if SymbolicRefs should be matched.
	MatchWholeWord	True if the search should only match whole words.
	Scope	The starting CodeObject of the search, such as a Solution, Project, or CodeUnit.
	TargetText	The text being searched for.
	UseRegularExpressions	True if regular expressions are being used.

Top

Remarks

This is a search of a tree of CodeObjects, NOT a text file search. Text that is searched can include names of declaratons (names of objects implementing INamedCodeObject), SymbolicRef names, and text in Literals, Comments, DocComments, and Messages. Punctuation, operators, and statement keywords are NOT searched by this class, and it matches only individual CodeObjects (not multiple adjacent objects). If you wish to find all CodeObjects of a particular type, see FindByType. To perform a search, create an instance of this class, set any desired search parameters, call Find, and then look at Results. You may bind the Results property to a UI control, and the Find method may be called on a background thread.

Reference

Nova.Analysis Namespace