FindReferences Class

Represents a search of a CodeDOM tree for references (SymbolicRefs) to a target object, and the search results.

Inheritance Hierarchy

SystemObject
Nova.AnalysisFindReferences

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

Syntax

Copy

public class FindReferences : IVisitor

The FindReferences type exposes the following members.

Constructors

	Name	Description
	FindReferences	Create an instance that searches for references to the specified target object.

Top

Properties

	Name	Description
	Results	The results of the search.
	Target
	VisitHiddenRefs	Returns true for FindReferences, because we want to check any hidden references.

Top

Methods

	Name	Description
	AddResult
	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
	_declaringTypeRef
	_isInterface
	_isType
	_results
	_target	The target object for which references should be found.
	_targetName
	_targetTypeRef
	IncludeDerivedTypes	True if derived types should be included if searching for references to a type, or implementing types and extending interfaces if the target type is an interface.
	IncludeMemberReferences	True if references to members should be included if searching for references to a type.
	IncludeOverloads	True if overload declarations should be included if searching for references to a method (or constructor), and any references to those overloads if IncludeReferences is true.
	IncludeOverrides	True if override declarations should be included if searching for references to a method or property (or indexer or event). References to overrides are always included if IncludeReferences is true, regardless of this setting.
	IncludeReferences	True if references to the target should be included (can be turned off when other options are used).
	Scope	The starting CodeObject of the search, such as a Solution, Project, or CodeUnit.

Top

Remarks

The target object is usually a declaration, such as a TypeDecl, MethodDecl, FieldDecl, LocalDecl, etc. Or, it can be an external object, such as a TypeDefinition/Type, MethodDefinition/MethodInfo, etc. It can also be a string representing an UnresolvedRef. 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