PerformanceAdviser

Description:
The tool to report performance problems in a given document.

Remarks:
Class is an application-wide singleton that performs a dual role: it is a repository of rules to run in order to detect potential performance problems as well as an access point to execute checks.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.PerformanceAdviser

public class PerformanceAdviser : IDisposable

Public Class PerformanceAdviser
	Implements IDisposable

public ref class PerformanceAdviser : IDisposable

type PerformanceAdviser = 
    class
        interface IDisposable
    end

//Get the name of each registered PerformanceRule and then execute all of them.
foreach (PerformanceAdviserRuleId id in PerformanceAdviser.GetPerformanceAdviser().GetAllRuleIds())
{
    string ruleName = PerformanceAdviser.GetPerformanceAdviser().GetRuleName(id);
}
PerformanceAdviser.GetPerformanceAdviser().ExecuteAllRules(document);

Name	Return Type	Description	Inherited From
M AddRule(PerformanceAdviserRuleId, IPerformanceAdviserRule)	None	Adds a performance adviser rule to the list of rules.
M DeleteRule(PerformanceAdviserRuleId)	None	Deletes a performance adviser rule from the list of rules.
M Dispose()	None	Releases all resources used by the PerformanceAdviser
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M ExecuteAllRules(Document)	IList<FailureMessage>	Executes all rules in the list on a given document.
M ExecuteRules(Document, IList<PerformanceAdviserRuleId>)	IList<FailureMessage>	Executes selected rules on a given document.
M ExecuteRules(Document, IList<Int32>)	IList<FailureMessage>	Executes selected rules on a given document.
M GetAllRuleIds()	IList<PerformanceAdviserRuleId>	Retrieves an enumeration of rule Ids.
M GetElementFilterFromRule(Int32, Document)	ElementFilter	Retrieves a filter to restrict elements to be checked.
M GetElementFilterFromRule(PerformanceAdviserRuleId, Document)	ElementFilter	Retrieves a filter to restrict elements to be checked.
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetNumberOfRules()	Int32	Retrieves number of performance adviser rules in the list.
M GetPerformanceAdviser()	PerformanceAdviser	Returns the only instance of PerformanceAdviser in the Application.
M GetRuleDescription(Int32)	String	Retrieves the description of the rule.
M GetRuleDescription(PerformanceAdviserRuleId)	String	Retrieves the description of the rule.
M GetRuleId(Int32)	PerformanceAdviserRuleId	Retrieves an id of a rule for a given index in the list.
M GetRuleName(Int32)	String	Retrieves the name of the rule.
M GetRuleName(PerformanceAdviserRuleId)	String	Retrieves the name of the rule.
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M IsRuleEnabled(Int32)	Boolean	Retrieves an enabled/disabled status for the given rule.
M IsRuleEnabled(PerformanceAdviserRuleId)	Boolean	Retrieves an enabled/disabled status for the given rule.
M PostWarning(FailureMessage)	None	Reports a problem detected during execution of a rule.
M SetRuleEnabled(Int32, Boolean)	None	Retrieves an enabled/disabled status for the given rule.
M SetRuleEnabled(PerformanceAdviserRuleId, Boolean)	None	Retrieves an enabled/disabled status for the given rule.
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object
M WillRuleCheckElements(Int32)	Boolean	Reports if rule needs to be executed on individual elements.
M WillRuleCheckElements(PerformanceAdviserRuleId)	Boolean	Reports if rule needs to be executed on individual elements.

Name	Return Type	Description	Inherited From
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.