AnalysisResultSchema

Description:
Contains all information about one analysis result. Each result may contain several measurements.

Remarks:
In order to take effect, the AnalysisResultSchema object has to be registered by calling SpatialFieldManager::RegisterResult, which returns result index for future references; to make changes to the properties of an already registered object, use method SpatialFieldManager::SetResultSchema and supply result index and replacing object.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Analysis.AnalysisResultSchema

public class AnalysisResultSchema : IDisposable

Public Class AnalysisResultSchema
	Implements IDisposable

public ref class AnalysisResultSchema : IDisposable

type AnalysisResultSchema = 
    class
        interface IDisposable
    end

// By default, each analysis result uses the Analysis Display Style assigned to the view.
// To display different types of results (colored surface, markers, diagram, vector) simultaneously in a single view
// the Analysis Display Style for each result must be set to a style that matches result's type
foreach (int result in spatialFieldManager.GetRegisteredResults()) // get all results for this SpatialFieldManager
{
   AnalysisResultSchema schema = spatialFieldManager.GetResultSchema(result);
   switch (schema.Name)  // check the name of the schema
   {
      case "Reactions": // based on the schema name, set the schema's Analysis Display Style
         schema.AnalysisDisplayStyleId = AnalysisDisplayStyle.FindByName(doc, "Vector");
         break;
      case "Shear":
         schema.AnalysisDisplayStyleId = AnalysisDisplayStyle.FindByName(doc, "Diagram");
         break;
      case "Plate Shear":
         schema.AnalysisDisplayStyleId = AnalysisDisplayStyle.FindByName(doc, "Surface");
         break;
   }
   spatialFieldManager.SetResultSchema(result, schema); // update the schema
}

Name	Return Type	Description	Inherited From
C AnalysisResultSchema(AnalysisResultSchema)	None	Constructs a new copy of the input AnalysisResultSchema object.
C AnalysisResultSchema(String, String)	None	Creates object and assigns name and description

Name	Return Type	Description	Inherited From
M Dispose()	None	Releases all resources used by the AnalysisResultSchema
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetNumberOfUnits()	Int32	returns number of possible units
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M GetUnitsMultiplier(Int32)	Double	returns units multiplier by index
M GetUnitsName(Int32)	String	returns units name by index
M IsEqual(AnalysisResultSchema)	Boolean	Determines if the input object is equivalent to this AnalysisResultSchema.
M SetUnits(IList<String>, IList<Double>)	None	Sets names and multipliers of all units for result visualization
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description
P AnalysisDisplayStyleId	ElementId	ElementId of analysis display style overriding the style set for view; -1 if the style is not overridden
P CurrentUnits	int	Stores the index in the array of applicable units
P Description	string	Description of analysis result in view
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P IsVisible	bool	If true analysis result is visible in view
P Name	string	Name of analysis result in view
P Scale	double	Multiplier used for displaying diagram or vector values in view.