Definition of offset surface, quoted from the STEP manual ISO 10303-42:2000(E): + This is a procedural definition of a simple offset surface at a normal distance from the originating surface. + Distance may be positive, negative, or zero to indicate the preferred side of the surface. + The offset surface takes its parametrization directly from that of its basis surface, corresponding points having + identical parameter values. The offset surface is parametrized as O(u, v) = S(u, v) + d*N(u, v), + where N(u, v) is the oriented unit normal vector of the basis surface S at parameter value (u, v), and d is the signed offset distance.
In Revit, we restrict the types of basis surfaces for which an OffsetSurf can be created for the following reasons:
The OffsetSurface class will own a copy of the basis surface and use it for many of its methods, which may implicitly assume that + the OffsetSurface and the basis surface have the same envelope. So we keep the envelopes of the OffsetSurf and its basis surface in sync.
If the comparer is for some reason unable to identify + the relations between the two object it should return value of + ElementComparisonResult.Incomparable. Such a situation is believed + to be rather rare though.
+The purpose of this string is to describe the comparer + in more details than just a short name alone could do. + The intended use is to show the string to the end user in the UI.
+Although a comparer is uniquely identified by its Id, + the Name can help to identify it to the end user in the UI.
+If the comparer is for some reason unable to identify + the relations between the two object it should return value of + ElementComparisonResult.Incomparable. Such a situation is believed + to be rather rare though.
+The purpose of this string is to describe the comparer + in more details than just a short name alone could do. + The intended use is to show the string to the end user in the UI.
+Although a comparer is uniquely identified by its Id, + the Name can help to identify it to the end user in the UI.
+If the comparer is for some reason unable to identify + the relations between the two object it should return value of + ElementComparisonResult.Incomparable. Such a situation is believed + to be rather rare though.
+The purpose of this string is to describe the comparer + in more details than just a short name alone could do. + The intended use is to show the string to the end user in the UI.
+Although a comparer is uniquely identified by its Id, + the Name can help to identify it to the end user in the UI.
+If the comparer is for some reason unable to identify + the relations between the two object it should return value of + ElementComparisonResult.Incomparable. Such a situation is believed + to be rather rare though.
+The purpose of this string is to describe the comparer + in more details than just a short name alone could do. + The intended use is to show the string to the end user in the UI.
+Although a comparer is uniquely identified by its Id, + the Name can help to identify it to the end user in the UI.
+An instance of this class is a single-time use class which should be supplied a + solid geometry, a plane, and a direction. The utility will calculate a base boundary + parallel to the input plane which is the outer boundary of the shadow cast by the + solid onto the input plane and along the extrusion direction.
+After the extrusion has been calculated, the class permits a second step + analysis to identify all faces from the original geometry which do not align with the + faces of the calculated extrusion.
+This utility works best for geometry which are at least somewhat "extrusion-like", + for example, the geometry of a wall which may or may not be affected by end joins, + floor joins, roof joins, openings cut by windows and doors, or other + modifications.
+CAD imports are not external file references, as their + data is brought fully into Revit. No connection is maintained + to the original file.
+A link may be an external resource without being an external file.
+ The input solid used for this filter can be obtained from an existing element, created from scratch
+ using the routines in GeometryCreationUtilities or builder classes, or the generated from the result of a
+ secondary operation such as a Boolean operation. Similar to the
This filter is a slow filter. + Slow filters require that the Element be obtained and expanded in memory first. + Thus it is preferable to couple this filter with at least one ElementQuickFilter, + which should minimize the number of Elements that are expanded.
+The target object is another element. The intersection is determined with the same logic used by Revit + to determine if an interference exists during generation of an Interference Report. (This means that some + combinations of elements will never be detected as intersecting by this filter, such as concrete members which are automatically + joined at their intersections). Also, elements which have no solid geometry, such as Rebar, will never be detected + as intersecting by this filter.
+This filter is a slow filter. + Slow filters require that the Element be obtained and expanded in memory first. + Thus it is preferable to couple this filter with at least one ElementQuickFilter, + which should minimize the number of Elements that are expanded.
++ Unregistering an updater from a document is only permitted if + the updater was explicitly registered for that document. +
++ If the updater was registered in other documents too, + the remaining documents will still have the updater assigned. +
++ However, if after unregistering from the document the updater is found + not registered in any other (currently open) documents, the updater + will be completely removed from the registry including its triggers. + Should the updater be registered again later, the triggers need + to be re-applied. +
+The registry is an application-wide singleton. It maintains all dynamic + updaters currently registered, and also invokes them per their respective + trigger condition during subsequent transactions. +
+Please note that only the application (an add-in, typically) which registered + an updater is allowed to modify it later, including unregistering it. + Also, an application is not allowed to register an updater with an Id, + that is based on another application's Id. +
+Another ways of setting the name is either during construction
+ or during the
HasStarted may return True even after 'Commit' or 'RollBack' was called + if the method returned the TransactionStatus.Pending value.
A transaction can only be Started when HasStarted returns false.
The options are only used temporarily during this rolling back process. After + the transaction is finished, the options will be reset to their default values.
+Be aware that the returned status does not have to be necessarily the same like
+ the status returned by
Be aware that the returned status does not have to be necessarily the same like
+ the status returned by
The options are only used temporarily during the commitment process. After + the transaction is finished, the options will be reset to their default values.
+Note it is possible the RolledBack status is returned instead as an outcome + of failure handling. If TransactionStatus.Pending is returned it means that + failure handling has not been finalized yet and Revit awaits user's actions. + Until committing is fully finalized, no changes to the document can be made + (including starting of new transactions).
Be aware that the returned status does not have to be necessarily the same like
+ the status returned by
Note it is possible the RolledBack status is returned instead as an outcome + of failure handling. If TransactionStatus::Pending is returned it means that + failure handling has not been finalized yet and Revit awaits a user actions. + Until committing is fully finalized, no changes to the document can be made + (including starting of new transactions).
The returned status does not have to be necessarily the same as
+ the status returned by
A transaction may be started only after it was instantiated or after it + was previously committed or rolled back.
+Be aware that every time a transaction starts,
+
A transaction may be started only after it was instantiated or after it
+ was previously committed or rolled back. In order to start a transaction,
+ it must have a name assigned. If the name was not specified when the
+ transaction object was instantiated, it has to be set by calling
+ the
Be aware that every time a transaction starts,
+
The transaction does not start by creating a transaction object. + One of the 'Start' methods will need to be called in order to start + this transaction.
+A transaction cannot start unless is has a valid (non-empty) name. + Because this constructor does not take a name, a name must be assigned later + before or during the 'Start' method.
+Any change to a document can only be made while there is an active transaction
+ open for that document. Changes do not become part of the document until the
+ active transaction is
A document can have only one transaction open at any given time.
+Transactions cannot be started when the document is in read-only mode, + either permanently or temporarily. See the Document class methods IsReadOnly + and IsModifiable for more details.
+Transactions in linked documents are not permitted, + for linked documents are not allowed to be modified.
+ +If a transaction was started and not finished yet by the time the Transaction object
+ is about to be disposed, the default destructor will roll it back automatically, thus all
+ changes made to the document while this transaction was open will be discarded.
+ It is not recommended to rely on this default behavior though. Instead,
+ it is advised to always call either
+ If %hostId% is the id of a Stairs Component (Run or Landing), it means that the Railing will be hosted by the Stairs element but railing adjustment to the stairs will start from the Component. + If a stairs id is set as a host, the lowest stairs component below or above the railing sketch will be chosen as the host instead. +
This method accepts a reference to a model face, and a transform to be applied to + that face, allowing the display of analytical results on faces which are not + strictly a part of the Revit model.
+This method should not be used if the transform is the identity transform, + i.e. the intent is to display results on a face which is part of the Revit model. + In that case, use the overload of this method which accepts + a reference.
+If the input face is from the geometry of a symbol, the face will be considered to be + in the location specified by its symbol geometry. If your intention is to transform the face + relative to its location in the instance, your input transform must consist of the instance's + transform left multiplied by the extra transform to get the results you expect.
+There can be multiple primitives associated with one reference, normally they would be shown with different results. + However this is justified only if they have different sets of domain points. + Otherwise one primitive can be used to display values for different results.
+There can be multiple primitives associated with one reference, normally they would be shown with different results. + However this is justified only if they have different sets of domain points. + Otherwise one primitive can be used to display values for different results.
+In a schedule with an embedded ScheduleDefinition, a column may + display two fields, one from each ScheduleDefinition. In that case, + the larger of the two widths is used.
+It is always aligned with the SheetColumnWidth.
+In a schedule with an embedded ScheduleDefinition, a column may + display two fields, one from each ScheduleDefinition. In that case, + the larger of the two widths is used.
+It is always aligned with the GridColumnWidth.
+A multistory stairs element may contain multiple stairs whose extents are governed by base and top levels.
+ Use
This element will contain one or more Stairs elements. These can be obtained via
For groups of duplicate stairs at different levels, the instances can be found as Subelements of the Stairs element (see
+
Stairs in a connected group can be edited together by modifying the associated Stairs instance. For specific floors that need special designs,
+ stairs can be separated from a group by unpinning the element, changes made to this Stairs will not affect other any other instance in the element.
+ Use
You can add the stairs back into the group via
Returns the RouteAnalysisSettings element in project documents
+ or
The speed value is stored in terms of Revit internal SI Units, which is feet per second.
+ To convert between desired and internal units
When this setting is true, elements with category ids returned by
+
RouteAnalysisSettings is an element which contains project-wide settings for route calculations.
+ The
By default, the route will go around the geometry of all visible model elements which have model geometry in the Route Analysis Zone.
+The Route Analysis Zone, determined per view, is the space between these two horizontal planes:
+ a top plane vertically offset by
You can adjust the Route Analysis Zone using
You can specify a set of model categories you would like ignored during route calculation.
+ To enable ignoring the set of specified categories, set
The class owns single-method interfaces which are used as callbacks to perform specific operations + on Revit link external resources.
+An empty RevitLinkOperations instance is passed to an IExternalResourceServer (inside an + ExternalResourceServerExtensions object) via the GetTypeSpecificServerOperations method. The server + provider can then add their own implemented interface objects to the RevitLinkOperations, thus + making them available to Revit to use as callbacks.
+Supporting these additional, type-specific operations is not absolutely required, but is strongly + recommended in order for users to be able to perform all the same operations they would with + locally-accessed Revit links.
+If there are more alphanumeric revisions than there are + strings in the sequence, subsequent alphanumeric revisions will + be assigned duplicated characters. For example, if the sequence + provided were ["X", "Y"], the first alphanumeric revision would + be shown as "X", the second as "Y", the third as "XX", then "YY", + "XXX", etc.
+The custom sequence to be used as numbers for revisions with the + Alphanumeric RevisionNumberType.
+If there are more alphanumeric revisions than there are + strings in the sequence, subsequent alphanumeric revisions will + be assigned duplicated characters. For example, if the sequence + provided were ["X", "Y"], the first alphanumeric revision would + be shown as "X", the second as "Y", the third as "XX", then "YY", + "XXX", etc.
+ + + The prefix string for each revision number in the sequence. + + + The suffix string for each revision number in the sequence. + +This RevisionCloud may not be visible in all ViewSheets reported by this method. + Additional factors, such as the visibility settings or annotation crop of the Views or the visibility settings + of the associated Revision may still cause this RevisionCloud to not appear on a particular ViewSheet.
If this RevisionCloud is owned by a ViewLegend, no sheets will be returned because the RevisionCloud + will not participate in revision schedules.
RevisionClouds can be created in most graphical Views, excepting 3D views and graphical column schedules. Unlike + most other Elements, RevisionClouds can be created directly on a ViewSheet.
RevisionClouds are created based on a series of sketched curves. There is no requirement that the curves form + closed loops and self-intersections are also permitted. The curves will be automatically projected onto the appropriate + plane for the View. The list of curves cannot be empty and any lines cannot be perpendicular to the View's plane. + If the View is a model View, the coordinates specified for the curves will be interpreted in model space. If the View + is a non-model View (such as a ViewSheet) then the coordinates will be interpreted in the View's space.
The cloud graphics will be attached to the curves under the assumption that each curve is oriented in a clockwise direction. + For lines, this means that the outside of the cloud is in the direction of the line's normal vector within the View's plane. Any closed loops should + therefore be oriented clockwise to create the typical cloud shape.
When a RevisionCloud is visible on a + ViewSheet (either because it is directly placed on that ViewSheet or because it is visible in a View placed on the ViewSheet), + any revision schedules displayed on the ViewSheet will automatically include the Revision associated with the RevisionCloud.
Note also that when a RevisionCloud is created in a ViewLegend, it is treated as a legend representation of what a RevisionCloud + looks like rather than as an actual indication of a change to the model. As a result, RevisionClouds in ViewLegends will not affect the contents + of revision schedules.
RevisionClouds are created from a collection of sketched curves. Each curve will have a series of "cloud bumps" drawn + along it to form the appearance of a cloud. There is no requirement that the curves form closed loops.
The shape parameters of a Rebar can be accessed via
The parameters at a specific index in a Rebar set can be accessed via
This property is assigned to varying Rebar sets
+ only if they are numbered as a whole (i.e.
The shape parameters of a Rebar can be accessed via
The parameters at a specific index in a Rebar set can be accessed via
If this property is true, then the Revit numbering mechanism (
If set to false, no Reference to any Element from a Revit Link will be found by the ReferenceIntersector, + and you can be certain that any Reference returned will be to a host document Element only. If set to true, + the results may include both References to Elements in hosts and References to Elements from a link + instance.
+Setting this value to true may interact with some other settings on the ReferenceIntersector. If a list of target ElementIds is set, + references will be returned only if the ElementId matches the id of the intersected RevitLinkInstance. If there is a match, any intersecting + elements in the link will be returned (their ids will not be compared with the target ids list). If there is an ElementFilter + applied, the elements in the link will be evaluated against the stored ElementFilter.
+Note that results may not be as expected if the filter applied is geometric (such as a BoundingBox filter or ElementIntersects filter). + This is because the filter will be evaluated for linked elements in the coordinates of the linked model, which may not match the coordinates + of the elements as they appear in the host model. Also, ElementFilters that accept a Document and/or ElementId as input during + their instantiation will not correctly pass elements that appear in the link, because the filter will not be able to match link elements to + the filter's criteria.
+An instance of this class can be constructed to return any 3D geometric element that intersects the + ray created by the origin and direction, or to return a subset of elements based on filtering and flags. + The caller can opt to filter the results using an ElementFilter, or by applying a specific list of + acceptable elements. The caller can also specify the type of object to be returned, which might be + whole elements, geometry objects, or a combination. In all cases the caller is required to supply + a 3D view for evaluation; the view and visibility settings on the input view will determine if a + particular element is returned (for example, hidden elements will never be returned by this tool, nor + will elements whose geometry is outside the section box of the view).
+The class is configured so that a single instance can be constructed and used for multiple evaluations of + different rays. The results of the evaluation are not preserved between invocations on the same ReferenceIntersector.
+The class also offers an option to return element results encountered in Revit Links. When the
+
The source and destination hosts represented by the source and destination references can be the same element or can be difereent elements. They can also be of different categories
+The destination host must be able to host rebar.
+The source rebars should not be gourp members.
+This method uses its own transaction, so it's not permitted to be invoked in an active transaction.
+The source and destination hosts should be of the same category.
+The source and destination hosts should be different elements.
+The destination host must be able to host rebar.
+The source rebars should not be gourp members.
+This method uses its own transaction, so it's not permitted to be invoked in an active transaction.
+For Shape Driven Rebar Constraints:
+Each handle on a rebar is defined by a plane, and can be constrained along the
+ direction perpendicular to the plane. Rebar constraints work by locking the
+ handle planes to planar references, or 'targets.' These targets can be:
+
For planar host element surfaces, a rebar handle can either be locked at a constant + distance, or, if the host surface has a specified cover, then the handle can be + joined directly to the cover of the surface.
+Standard style bars can be locked to the handle planes of stirrup style rebar. + In the special case of a straight, standard style bar, running perpendicular + to the plane of the stirrup bar, the bar can constrain itself to distinct locations + along bends in stirrup bars - points located at 0 degrees, 45 degrees, 90 degrees, + etc. around each bend. This is done by simultaneously locking both the straight + bar's edge handle and its planar position handle to one or both of the stirrup edges + adjacent to the bend in the stirrup.
+Usually, to form a constraint, the handle plane and the reference plane must be parallel. + However, bar end handles can be constrained to planes at angles up to 60 degrees. + Arc-shaped rebar is a special case, and can form constraints to concentric host surfaces.
+RebarConstraints can only be constructed internally by Revit. They are + available to the API by querying a rebar element's RebarConstraintsManager.
+For Free Form Rebar Constraints:
+Each handle of the Rebar can be constrained to multiple host faces or to the face cover.
+In order to create a Free Form Rebar Constraint you will need:
+
RebarConstraints for Free Form Rebar should be created using the Create method and then added to + the RebarConstraintsManager using the method SetPreferredConstraintForHandle.
+A rebar element's flexible geometry is controlled by several handles. The shape + of the bar is controlled by a handle at each end of the bar (blue circle controls) + and a handle each edge (blue triangle controls). Another handle is used to + control the location of the plane in which the rebar lies. An additional handle + controls the length of a set of rebar.
+RebarConstrainedHandles can only be constructed internally by Revit. They are + available to the API by querying a rebar element's RebarConstraintsManager.
+This function can fail due to following reasons:
+This function can fail due to following reasons:
+The input parameter needs to be bound to the Rebar element
+The rebar element needs to have a valid external server
+The input parameter needs to be bound to the Rebar element
+The rebar element needs to have a valid external server
+If this Rebar has Workshop Instructions set to Straight will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetEndTreatmentTypeId(int end).
+If this Rebar has Workshop Instructions set to Bent there are different cases:
+
If this Rebar has Workshop Instructions set to Straight will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetCouplerId(int end).
+If this Rebar has Workshop Instructions set to Bent there are different cases:
+
If this Rebar has Workshop Instructions set to Straight will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetHookOrientation(int end).
+If this Rebar has Workshop Instructions set to Bent there are different cases:
+
If this Rebar has Workshop Instructions set to Straight will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as RebarFreeFormAccessor.GetHookOrientationAngle(int end).
+If this Rebar has Workshop Instructions set to Bent there are different cases:
+
If this Rebar has Workshop Instructions set to Straight will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetHookTypeId(int end).
+If this Rebar has Workshop Instructions set to Bent there are different cases:
+
If this Rebar has Workshop Instructions set to Straight will return false for all barPositionIndex between 0 and (NumberOfBarPositions-1).
+If this Rebar has Workshop Instructions set to Bent there are different cases:
+
ShapeDriven : The input constraints belong to other rebar in a (different) similar host. Only constraints of type ToHostFace or ToCover are considered. + The method modifies the constraints' target references with their correspondants in current host(s). + The modified constraints are set in current rebar. + The method will fail : if there exists at least one ToOtherRebar constraint; if corresponding target references in current host(s) are not supplied or found.
+FreeForm : The constraints will not be applied and the method will return false.
+The two arrays go hand in hand : they must have the same size; the correspondant of oldReference at index x is found in the other array at the same index x.
+For a free form rebar valid targets are one or more references to faces of elements that can host rebar.
+For a shape driven rebar this function will always return false. RebarConstraintsManager.GetConstraintCandidatesForHandle() can be used to obtain possible constraints.
+For ShapeDriven: Returns the RebarConstraint that has been set as preferred for the specified RebarConstrainedHandle.
+For FreeForm: Returns the RebarConstraint that acts on the specified RebarConstraintHandle.
+For ShapeDriven: Clears the user-preferred RebarConstraint from the specified RebarConstrainedHandle.
+For FreeForm: Removes the RebarConstraint that is associated to the specified RebarConstrainedHandle.
+ShapeDriven:
+After the preferred constraint is removed, the rebar will search for an appropriate + default constraint for the handle in its current position. In some cases, this will + cause the handle to snap a small distance to a new target. However, in many situations, + the handle will simply remain in its current position, and either continue to use the + same constraint target (while no longer treating that target as preferred), or acquire + a FixedDistancetoHostFace constraint to the nearest host element surface. + The handle will not, in general, be restored to the position it originally occupied + before the preferred constraint was applied.
+FreeForm:
+After the Constraint is removed, the handle remains unconstrained, and the shape calculation + tries to resolve a shape without this information. Depending on the calculation method, + the bar may not have all the necessary information, so the responsibility to constrain + this handle is in the hands of the caller of this function.
+For ShapeDriven Rebar: Sets the RebarConstraint as preferred constraint target for the specified RebarConstrainedHandle.
+For FreeForm Rebar: Sets the RebarConstraint as the target for the specified RebarConstraintHandle.
+ShapeDriven:
+The RebarConstraint should be one of the candidate RebarConstraints returned by + getConstraintCandidatesForHandle.
+In general, the caller should assume that the 'set' operation can fail, as some + of the candidates may be legal targets for the handle, but may cause the rebar + to flex into an insoluble shape.
+Once a preferred constraint has been successfully assigned to a handle, the + user can still drag the handle, and the Rebar can generally be flexed in much + the same way as it could before (preferred constraints do not have the same + effect as Revit locked dimensions). However, the rebar's behavior will change + in subtle ways.
+A handle with a FixedDistanceToHostFace preferred constraint will allow the + constraint's offset distance to change as the user moves the handle. However, + in subsequent model updates, the handle will continue to follow the preferred + constraint target, even if other legitimate constraint targets are closer to + the handle. One can think of this behavior as equivalent to unlocking a + locked dimension, moving one of dimension references, and then re-locking the + dimension - all in one step.
+When a handle with a ToCover or ToOtherRebar preferred constraint is dragged by + the user, it will snap back to its constraint target, unless it is dragged + beyond tolerance distance. In that case, it will select a new constraint using + default logic, but will continue to treat the "broken" constraint as preferred, + and will snap back to the preferred target again, if it is dragged to within + tolerance distance.
+If, during a model update, the rebar determines that a preferred constraint + target no longer exists, or has been modified so that it is no longer a legal + candidate for the handle, then the rebar will remove the preferred status of + that target and will assign a new constraint to the handle using the default + logic.
+FreeForm:
+Sets the RebarConstraint to be active for the specified RebarConstrainedHandle. + The RebarConstrainedHandle needs to be a valid handle for this rebar element.
+For shape driven rebar returns all possible RebarConstraints that will constrain RebarConstrainedHandle to the provided reference.
+For free form rebar will return an empty lists.
+For shape driven rebar returns all possible RebarConstraints belonging to references from the provided element that could be used for a specified RebarConstrainedHandle.
+For free form rebar will return an empty list.
+For shape driven rebar returns all possible RebarConstraints that could be used for a specified RebarConstrainedHandle.
+For free form rebar will return an empty list.
+A RebarConstraintsManager is created by calling Rebar.GetRebarConstraintsManager(), + and can only be used to query or change constraints on the rebar element that + created it.
+There are two types of constraint manager, depending on the type of Rebar that created it: + Shape Driven constraints and FreeForm constraints
+-----ShapeDriven-----
+If the Rebar is Shape Driven, Revit uses the following logic to choose constraints for each handle + on a rebar element. First, a search is performed to find all suitable target + planes, including surfaces of the rebar's host, as well as surfaces on other + concrete host elements that are attached to the rebar's host. In the case of + standard style rebar, any host surface occupied by a stirrup will be ignored, + and instead, the handles on the stirrup itself will be treated as candidates + to form a constraint.
+Once all the constraint target candidates have been determined, the following
+ sequence is used to select a constraint target:
+
Snapping tolerances are 0.5 * bar diameter for host surface cover constraints and + 0.5 * (bar diameter + stirrup bar diameter) for stirrup handle constraints.
+The RebarConstraintsManager allows the API developer to obtain the constraint + candidates for each constrained handle on a rebar, and to override the default + target selection logic by setting a particular constraint as preferred. This + can be useful in a number of ways. First, it can be used to snap a handle to a + particular host surface or stirrup rebar handle, or to position a handle at a + precise distance from a host surface. Second, it can force a rebar handle to + constrain itself to a particular target surface, even if other targets are closer + (or will become closer in subsequent updates of the Revit model). For example, + a bar can be constrained to maintain a constant offset distance from a face of + an opening in a slab, even if the opening is placed close to the edge of the slab + and the bar would normally constrain itself to the slab edge. Lastly, the override + can be used to cancel the default standard bar preference for stirrup bar handle + planes, and to allow standard bars to be constrained to host cover surfaces, even + when a stirrup is present.
+----- FreeForm -----
+ If the rebar is FreeForm, then it requires input constraints that will be consumed to
+ obtain the actual shape of the bar. The calculation method of the constraints passed
+ to the rebar is custom made by an API application -
The RebarConstraintsManager can return all the possible "shape" handles + and can set constraints created only with one of those handles. + There are only active constraints on a FreeForm bar, the current and preferred notions + represent the same thing.
+For closed loop hydronic piping networks, Revit can analyze flow and pressure values for supply and return loops. In the model, select a pump to see the results of the analysis in the Properties palette.
+A closed loop hydronic piping network must contain:
+A network may contain a direct return loop or a reverse return loop.
+This method can be used for both view-specific and model elements.
+Both source and destination views must be 2D graphics views capable of drawing details and view-specific elements (floor and ceiling plans, elevations, sections, drafting views.) + Drafting views cannot be used as a destination for model elements.
+The pasted elements are repositioned to ensure proper placement in the destination view (e.g. elevation is changed when copying from a level to a different level.) + Additional transformation within the destination view can be performed by providing additionalTransform argument. This additional transformation must be within the plane of the destination view.
+The destination view can be in the same document as the source view.
+The destination view can be the same as the source view.
+All view-specific elements in the set must be specific to the source view. Elements specific to views other than the source view or to multiple views cannot be copied.
+This method performs rehosting of elements where applicable.
+Copies are placed at their respective original locations or locations specified by the optional transformation.
+This method can be used for copying non-view specific elements only. For copying view-specific elements, use the view-specific form of the CopyElements method.
+The destination document can be the same as the source document.
+This method performs rehosting of elements where applicable.
+Revit does not post these warnings. They are provided as a convenience + to the API user, who may wish to post them.
+The information in the warnings is also captured in the other error + functions of KeyBasedTreeEntriesLoadResults.
+A KeyBasedTreeEntriesLoadResults object is returned by the KeynoteTable or AssemblyCodeTable API methods LoadFrom() and Reload() so that callers can + determine whether the KeynoteTable or AssemblyCodeTable was updated successfully and what, if any, errors occurred.
+A wall sweep is an object that is created by sweeping a closed 2d profile along a horizontal line + that is positioned on one side (exterior or interior) of the hosting wall. + A reveal is a special wall sweep with a void shape that is subtracted from the hosting wall.
+The id field of the WallSweepInfo must be populated with a non-negative integer value. + If there already is a sweep defined for this id, its parameters will be changed. + A new sweep will be created if no existing one has matching id.
+ A compound structure consists a collection of ordered layers, proceeding from exterior to interior for a wall, or from top to bottom for a
+ floor, roof or ceiling. The properties of these layers determine the
+ thickness, material, and function of the overall structure of the associated wall, floor, roof or ceiling. Layers can
+ be accessed via the
A structure supports the concept of "core layers" and "shell layers". There are two layer indices which identify
+ where the boundary between core and shell layers occur in the list of layers. The boundaries between shell and core layers
+ are identifiable using
+
Compound structures may be vertically compound. If
For by range scheme:
+For by value scheme:
+To make sure that entry can be added to the scheme, call
The following entry fields can be updated:
+Notes:
+A color scheme is based on element category and one of the category parameter, it contains a
+ set of
You can retrieve the entries with
Unlike most of the other elements, the color scheme works in an "asynchronous" way in UI:
+API works slightly different with UI:
+Notes:
+Color fill legend is a 2D annotation element, it can be created through
Notes:
+The class contains a KeyBasedTreeEntries object which should hold the KeyBasedTreeEntries data generated by the + IExternalResourceServer.
+An ExternalResourceServer can create the KeyBasedTreeEntries from an arbitrary data source by using AddEntry + to add individual KeyBasedTreeEntries. Once all the desired entries have been added, BuildEntries can be called + to construct the KeyBasedTreeEntries object from the individual entries that were added.
+KeyBasedTreeEntriesLoadContent must have a built KeyBasedTreeEntries before its LoadStatus property + can be set to ExternalResourceLoadStatus.Success.
+The class owns single-method interfaces which are used as callbacks to perform specific operations + on DWG link external resources.
+An empty CADLinkOperations instance is passed to an IExternalResourceServer (inside an + ExternalResourceServerExtensions object) via the GetTypeSpecificServerOperations method. The server + provider can then add their own implemented interface objects to the CADLinkOperations, thus + making them available to Revit to use as callbacks.
+Supporting these additional, type-specific operations is not absolutely required, but is strongly + recommended in order for users to be able to perform all the same operations they would with + locally-accessed links.
+This filter is a quick filter. + Quick filters operate only on the ElementRecord, a low-memory class which has + a limited interface to read element properties. Elements which are rejected + by a quick filter will not be expanded in memory.
+Note that it may be faster to get a list of symbol ids from
+
+ The total number of control points must equal numControlPtsU times numControlPtsV,
+ where numControlPtsU and numControlPtsV are the numbers of control points in u and v directions,
+ and they must satisfy the following conditions:
+
+ The convention for 2d (idxU, idxV) to 1d (idx) conversion of array indexes: idxV first.
+ That is, idxU is outer loop and idxV is inner loop. In other words,
+ idx = idxU * numControlPtsV + idxV.
+
+ The total number of control points must equal numControlPtsU times numControlPtsV,
+ where numControlPtsU and numControlPtsV are the numbers of control points in u and v directions,
+ and they must satisfy the following conditions:
+
+ The convention for 2d (idxU, idxV) to 1d (idx) conversion of array indexes: idxV first.
+ That is, idxU is outer loop and idxV is inner loop. In other words,
+ idx = idxU * numControlPtsV + idxV.
+
A LinkLoadResult object is included in the LinkLoadContent class so that + IExternalResourceUIServers will have additional information about the status of the + link to display to the user.
+The LinkLoadResult is added to the LinkLoadContent object during the load operation, + after the IExternalResourceServer LoadResource method has been called. + Consequently, this method will return NULL if called from the LoadResource method + of an IExternalResourceServer.
+This path must be a location accessible to Revit. Revit will + attempt to load the link from this location.
+This class handles Revit links.
+Revit links must be loaded from a path accessible to Revit. + Server implementors should provide Revit with a ModelPath representing + a location from which to load the link. Revit will handle the actual + file loading.
+Servers which represent non-local file locations will need to + create their own implementation for copying + or moving files to a Revit-accessible location.
+The link data path used for link loading may be different from
+ the path displayed to the
+ user. The link data path represents the literal location of the
+ file, whereas the link's display path represents what the user sees
+ as the name of the link. See
The ExternalDefinition object can be created by a definition Group object from a shared parameters file. + External parameter definition must belong to a Group which is nothing more than a collection of shared + parameter definitions. The following process should be followed to add a parameter to an + element: Open the shared parameters file, via the Application.OpenSharedParameterFile() method. + Access an existing or create a new group, via the DefinitionFile.Groups property. Access + an existing or create a new external parameter definition, via the + DefinitionGroup.Definitions property. Create a new Binding object with the categories to + which the parameter will be bound using an InstanceBinding or a TypeBinding object. Finally + add the binding and definition to the document using the Document.ParameterBindings object.
+Shared parameters added to elements are typically visible to interactive users. To add data to elements that + is never visible to interactive users, use Extensible Storage to construct and populate the needed structured + data.
+This filter will match elements whose class is an exact match to the input class, + or elements whose class is derived from the input class.
There is a small subset of Element subclasses in the API which are not supported
+ by this filter. These types exist in the API, but not in Revit's native object model,
+ which means that this filter doesn't support them. In order to use a class filter to
+ find elements of these types, it is necessary to use a higher level class and then
+ process the results further to find elements matching only the subtype. The following
+ types are affected by this restriction:
+
Only elements whose class is an exact match to one of the input classes, + or elements whose type is derived from the input class will pass the collector.
There is a small subset of Element subclasses in the API that are not supported
+ by this filter. These classes exist in the API, but not in Revit's native object model,
+ which means that this filter doesn't support them. In order to use a class filter to
+ find elements of these types, it is necessary to use a higher level class and then
+ process the results further to find elements matching only the subclass. For a list
+ of subclasses affected by this restriction, consult the documentation for
A Free Form Rebar that has Workshop Instructions set to Bent is considered that can be matched with multiple shapes.
+A Free Form Rebar that has Workshop Instructions set to Straight or a Shape Driven Rebar is considered that can be matched with only one shape.
+For ShapeDriven Rebar: + returns true, if the Rebar element's external constraints are available for editing using the + RebarConstraintsManager class. It will return false if Rebar is in Group
+For FreeForm rebar: + constraints can be edited if there is a valid external server Guid assigned to that Rebar
+A Free Form Rebar that has Workshop Instructions set to Bent is considered to have multiple shapes and this method will throw exception.
+A Free Form Rebar that has Workshop Instructions set to Straight or a Shape Driven is considered to have only one shape and this method will return the id of that shape.
+This function can fail due to following reasons:
+This function can fail due to following reasons:
+The sort only affects visible parameters within the same parameter group.
+Parameters that belong to different groups will remain separated, and the groups' order will not be affected.
+The sort is a one-time operation and when new parameters are added they will not be automatically sorted.
+Reordering the parameters only affects visible parameters within the same parameter group.
+Parameters that belong to different groups will remain separated, and the groups' order will not be affected.
+The parameters are family built-in parameters, category built-in parameters +and shared parameters associated to the family types.
+The collection consists of both visible and invisible parameters associated to the family types.
+The parameters are returned in the order in which they appear in the Revit UI within a given group; +however, parameters of different groups may be mixed within this output.
+Currently the Revit UI order is determined first by group and next by the order of the individual parameters.
+DocumentVersion consists + of two parts - a GUID and an integer. The GUID is updated as new elements + are created in the document, but it is not necessarily changed whenever + any individual change is made to the document. The integer is updated when + the document is saved.
+The GUID will change as changes are made to a model, so it should not be treated + as a static value.
+This class does not contain any time information - you cannot compare two
+ DocumentVersions and know which document is newer. It can be used
+ to tell whether a document has changed since it was last inspected.
+ See
Subelements provide a way for parts of an element to behave as though they were real elements without incurring the overhead of adding more full elements to the model.
+Many Revit features (for example parameters, schedules, and tags) were designed to operate on Elements. + As a result, the Revit code needs to represent objects as Elements for them to participate in those features. This can lead to scalability problems, + because every Element adds overhead and adding many Elements may decrease the performance of the model. An alternative is to use Subelements. An element + can expose a set of "Subelements" that it contains, specifying characteristics like their category and parameters, + and certain Revit capabilities will treat those Subelements the same as ordinary Elements. For example, a Subelement may contribute geometry to the main element + and may be able to be selected independently of its parent Element. It will possibly have its own (settable) type as well as an assigned category which + can be different from its parent Element.
+In the API, the new Subelement class is used to refer to either an Element or a specific subelement of a given Element. + It is typically directly related to a Reference to either the Element or the specific subelement. + Note that creation of new Subelements for a given element is not done generically. Instead, the given Element may provide the ability to modify it's definition, + resulting in the creation of new Subelements.
+Examples of Elements which may have Subelements in practice include:
+
To get access to a particular Subelement, you may use any of the following:
+
Must be
Allowed to be
Non-workshared models have whole-file backups, sequentially numbered.
+File-based workshared models have eager, incremental backups + in a backup folder adjacent to the model itself: + Every save backs up all changed data and avoids recopying unchanged elements, + so the latest backup is equivalent to the main copy on disk and + the backup folder does not have huge amounts of redundant data.
+A positive number means to keep at most that many backups.
+The default value of -1 means to use Revit's defaults: + 3 for non-workshared, 20 for workshared. + After initialization, the setter can be used to choose a positive number, + but cannot be used to restore this default value.
+An update is necessary if the view has never been displayed, or if + the model has been changed and the view has not been updated or accessed. + If the preview view has not been updated, the preview may not be properly + saved.
+This setting applies only to a single Save operation and is reset to + false after it is accessed.
+DirectContext3D handle instances are DirectShapes.
+DirectContext3D handle types are DirectShapeTypes.
+DirectContext3D graphics can be displayed without storing the graphics in elements. However, the reference to the externally generated
+ graphics will not persist beyond the current session, and there will be no capabilities for the user to select and interact with the graphics.
+ The utility methods in this class support creation and updating of DirectContext3D handle and handle instance elements (which for this release are
+
The type and instance relationship between DirectContext3D handles and handle instances allows one DirectContext3D server to act as the provider + of one set of graphics (the type) that the API displays in multiple locations, as determined by the handle instances.
+The handle element will be associated to a specified category. The only currently valid category is OST_Coordination_Model.
+The application is required to update the handle type element using
This class can perform drawing operations and access the state of parameters related to drawing only
+ in lock-step with rendering inside of Revit. As a consequence, the facilities of this class are not available for
+ use outside of the scope determined by the callback
Opaque and transparent geometry should be submitted for rendering separately.
+ See
+ The drawing facility of this class is conceptually similar to a low-level graphics API. + The functionality operates on a set of geometry primitives such as triangles, lines, and points, which are encoded into + a set of vertex and index buffers. +
++ Aside from submission of geometry in buffers, a major part of the drawing process is + responding to certain changes in graphics state. For example, users of this class can implement progressive rendering + of geometry by testing whether there have been interruptions that should prevent the drawing from being completed. +
+This table is structured as a mapping from
The table can be accessed via direct iteration as a collection of KeyValuePairs, or by traversal of the stored keys
+ obtained from GetKeys(), or via specific lookup of a key constructed externally. In all cases, the
+
This table is structured as a mapping from
The table can be accessed via direct iteration as a collection of KeyValuePairs, or by traversal of the stored keys
+ obtained from GetKeys(), or via specific lookup of a key constructed externally. In all cases, the
+
This table is structured as a mapping from
The table can be accessed via direct iteration as a collection of KeyValuePairs, or by traversal of the stored keys
+ obtained from GetKeys(), or via specific lookup of a key constructed externally. In all cases, the
+
This table is structured as a mapping from
The table can be accessed via direct iteration as a collection of KeyValuePairs, or by traversal of the stored keys
+ obtained from GetKeys(), or via specific lookup of a key constructed externally. In all cases, the
+
DirectContext3D graphics can be displayed with or without an associated DirectContext3D handle + element. For DirectContext3D graphics that utilize the handle element, the visibility and appearance of + the graphics can be adjusted through the Visibility/Graphics dialog.
+Note that changing the sequence of Revisions can change the SequenceNumber and RevisionNumber + of Revisions that have already been issued.
The revisions in the project are stored in a specific order called the revision + sequence. The revision sequence represents the conceptual sequence in which revisions + will be issued.
The id of the view to use as the link's reference view, if the reference + view has been deleted. Revit will ignore this value if the reference + view is still in place.
+The value may be ElementId.InvalidElementId, although Revit will + cancel the load if the reference view is deleted.
+ +If the link is currently loaded, any changes made in-memory + to the link's shared coordinates will be discarded.
+Graphic overrides will be preserved on reload.
+If the original view used to bring in this link has + been deleted, Revit will cancel the load.
+If there is already another link, not current link itself, + using the given external resource reference, the loading will not happen. + The element id of the link using the external resource reference will be contained + in the LinkLoadResult.
+This function checks the actual resource path that the IExternalResourceServer returns. + If the link type identified by the resource path doesn't match DWG, the load will not proceed.
+If the link is currently loaded, any changes made in-memory + to the link's shared coordinates will be discarded.
+Graphic overrides will be preserved on reload.
+If the original view used to bring in this link has + been deleted, Revit will cancel the load.
+If there is already another link, not current link itself, + using the given file path, the loading will not happen. + The element id of the link using the file path will be contained + in the LinkLoadResult.
+If the link type identified by the given path doesn't match DWG, + the load will not proceed.
+If the link is currently loaded, any changes made in-memory + to the link's shared coordinates will be discarded.
+If the link is currently loaded, any changes made in-memory + to the link's shared coordinates will be discarded.
+Graphic overrides will be preserved on reload.
+If the original view used to bring in this link has + been deleted, Revit will cancel the load.
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
++ This method only modifies your copy of the Entity. Store the Entity in an element or + another Entity to save the new value. Write access check is not performed on each call + to Set. Instead, write access is checked when you try to save the Entity in an Element + or another Entity. +
++ This method is a shortcut that will look up the field by name. If you want to call it + on many entities, it is faster if you look up the field yourself. +
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
++ This method only modifies your copy of the Entity. Store the Entity in an element or + another Entity to save the new value. Write access check is not performed on each call + to Set. Instead, write access is checked when you try to save the Entity in an Element + or another Entity. +
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
++ Note that when string values are specified as map keys, + they are case-insensitive. +
++ This method only modifies your copy of the Entity. Store the Entity in an element or + another Entity to save the new value. Write access check is not performed on each call + to Set. Instead, write access is checked when you try to save the Entity in an Element + or another Entity. +
++ This method is a shortcut that will look up the field by name. If you want to call it + on many entities, it is faster if you look up the field yourself. +
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
++ Note that when string values are specified as map keys, + they are case-insensitive. +
++ This method only modifies your copy of the Entity. Store the Entity in an element or + another Entity to save the new value. Write access check is not performed on each call + to Set. Instead, write access is checked when you try to save the Entity in an Element + or another Entity. +
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
++ This method is a shortcut that will look up the field by name. If you want to call it + on many entities, it is faster if you look up the field yourself. +
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
++ This method is a shortcut that will look up the field by name. If you want to call it + on many entities, it is faster if you look up the field yourself. +
++ The template parameter must match the type of the field (specified when creating the + Schema) exactly; this method does not perform data type conversions. The types for containers are + IList for arrays and + IDictionary for maps. +
+A filterable category in Revit has a set of filterable parameters. + The filterable parameters common to a set of categories is the + intersection of all these filterable parameter sets.
+This set defines the set of parameters that may be used to define + a rule on a ParameterFilterElement with a certain set of categories.
+Testing that an element's category is a member of this set is, + essentially, the first rule of the filter.
+Changing the set of categories will clear any rules that use parameters + that are not applicable for the new set of categories.
+Note that a value can only be set for parameters that are neither + formula-driven nor dimension-driven, as those have their values determined + by evaluating the formula or by the dimension, respectively.
+The argument this method accepts is of the same type of
Note that a value is always returned regardless of whether the + parameter is formula-driven, or dimension-driven, or independent.
+The returned
When a dimension is labeled by a global parameters, then its value is either + controlled by the parameter (non-reporting), or drives the value of the + parameter (reporting). It is important to note that a reporting parameter + can label at most one dimension object - meaning, a parameter can be driven + by one dimension only. If the dimension has several segments and is labeled by a non-reprting parameter, + the value of each segment will be driven by this parameter. Multi-segmented dimensions + cannot be labeled by reporting parameters.
+If the dimension is already labeled by another global parameter, + labeling it again will automatically detach it from that parameter.
+Presently, not just any kind of dimensions may be labeled by a global parameter.
+ Typically only single Linear and Angular dimensions can be labeled,
+ but there are other restrictions in effect too. Also, for the value of the parameter
+ and dimension labeled by it depend on each other, the data type of the global parameters
+ must be either Length or Angle, since those are the only units a dimension
+ can represent. Refer to the
In order to set a formula, the global parameter must be non-reporting. Therefore + a reporting parameter must be changed to non-reporting first before assigning a formula. +
+ Value of the evaluated formula must be compatible with the value-type of the parameter.
+ For example, it is permitted to use Integer parameters in a formula assigned to
+ a Double (Number) parameter, or vice versa. It is not allowed, however, to use
+ Length or Angle arguments in a formula in a parameter of which type is ether
+ Integer or Number. To test whether a formula is valid for a global parameter,
+ the method
+ An empty string can be used to remove an existing formula. When a formula is removed, + the parameter retains its value as it was previously computed using the formula. +
+ Formulas may include all standard arithmetic operations and logical operations (as functions and, + or, not.) Input to logical operations must be Boolean values (parameters of YesNo type). + Consequently, arithmetic operations can be applied to numeric values only. While there are no operations + supported for string (text) arguments, strings can be used as results of a logical If operation.
This method is a combined action of two steps: a) Making the parameter reporting if + it is not yet, and b) Labeling the given dimension with it. Because of that, the + parameter must be eligible for reporting - i.e must be of certain types, and must + not be used to label more than one dimensions yet.
+In case this parameter is already driven by another dimension, the other + dimension will be unlabeled first before the given one is labeled. It is because + a reporting parameter can only label one dimension at a time (i.e. it can be + driven by one dimension only.)
+Each global parameter must have a valid name that is unique within the document. To test whether
+ a name is unique, use the
While global parameters can be created with almost any type of data, there is a few types that
+ are not currently supported, such as the ElementId type. Programmers can test whether a particular
+ data type is appropriate for a global parameter by using the
Parameters are created as non-reporting initially, but programmers are free to modify the
Only reporting parameters can be driven by dimensions. Thus, to drive + a parameter by a dimension, the parameter must first be set as reporting + before it is used to label the driving dimension.
+Note that the value of this property is always the opposite of the
+
Note that the value of this property is always the opposite of the
+
When a global parameter is declared as reporting, it takes its value from + the one driving dimension it is set to label. To be declared as reporting, + a parameter must be labeling no more than one single-segment dimension. If a global parameter + is not labeling any dimensions at the time it is declared as reporting, + its value stays unchanged until a driving dimension is labeled with it.
+Reporting parameters can be (currently) only of type Length or Angle,
+ but programmers can always call the
+ Global parameters can be used to drive values of dimensions or other elements' parameters. + Also, a global parameter can be driven by a selected dimension, the value of which then + determines the value of the global parameter. Such parameters can further be used to drive + values of other elements' parameters.
+ + See also theThere are several ways global parameters can be categorized, but probably the most significant
+ categorization stems from the
Reporting parameters are limited in several ways. They can be only of Length or Angle type, + a requirement due to the fact that a dimension must be able to drive the value. For the same reason + reporting parameters may not have formulas.
Non-Reporting parameters, on the other way, can be of almost any type (Length, Integer, + Area, etc.) with the exception of ElementId type. Also, Non-Reporting parameters may have assigned + formulas in which other global parameters may be used as arguments. This way one global parameter's value + can be derived from other parameter (or parameters), and the other parameter can be either reporting + or non-reporting.
Global parameters get created via the static method
An alternative way of making a parameter reporting is via the
Other important properties of global parameters are
Like with family parameters, formulas may be assigned to non-reporting global parameters using the
+
Probably the most notable feature of global parameters is their ability to "Label" dimensions,
+ a process that establishes dependency of a dimension on a global parameter (or vice versa,
+ depending on the reporting status.) One parameter can label any number of dimensions as long
+ as the parameter is non-reporting. If the parameter labels a multi-segment dimension, values of all segments
+ of this dimension will be equal to the parameter's value. As mentioned above, reporting parameter can label one dimension
+ only, and this dimension can have only one segment. Methods and properties related to labeling include:
Global parameters can be associated with other global parameters as well as regular family instance
+ parameters (which may report global parameters as their values via the assignment formula.)
+ There are two methods available to find relations among parameters:
Methods for maintaining associations between element properties and global parameters
+ can be found in the
All global parameters, formula-driven, dimension-driven, or independent, have values. A value can
+ be obtained by calling the
The given property (parameter) must be parameterizable, meaning it cannot be + read-only, driven by a formula, or have any other restrictions imposed by Revit.
+The parameter's value type must match the type of this global parameter.
+Once associated property can be later dissociated by calling the
+
A parameter can only be moved within its parameter group, meaning that + repeated moving a parameter will not push the parameter out of and into + the next (in order) parameter group. When a parameter can no longer move + because it is at the boundary of its group, this method returns False.
+This operation has no effect on the global parameters themselves. + The rearranged order is only visible in the standard Global Parameters + dialog. However, the order of parameters is serialized in the document, + thus available on the DB level as well.
+A parameter can only be moved within its parameter group, meaning that + repeated moving a parameter will not push the parameter out of and into + the next (in order) parameter group. When a parameter can no longer move + because it is at the boundary of its group, this method returns False.
+This operation has no effect on the global parameters themselves. + The rearranged order is only visible in the standard Global Parameters + dialog. However, the order of parameters is serialized in the document, + thus available on the DB level as well.
+All global parameters are sorted, but only within the range + of their respective parameter group.
+This operation has no effect on the global parameters themselves. + The sorted order is only visible in the standard Global Parameters + dialog. However, the order of parameters is serialized in the document, + thus available on the DB level as well.
+The order of the items coresponds to the order at which global parameters + appear in Revit UI when shown in the standard Global Parameters dialog. + However, the order of parameters is serialized in the document, + thus available on the DB level as well.
+This class provides access to general information and data of Global Parameter
+ elements in a particular model. First of all, it is important to know that global
+ parameters can be had in main project document; there are not supported in family
+ documents. Availability of global parameters in a document can be tested by calling
+
Global Parameter in a document can be obtained by calling either
+
Each global parameters must be created with a valid name that is unique
+ in the scope of the document. To test whether a particular name is unique,
+ programmer can use the
More details about creating and manipulating global parameters can be found
+ in the description of the
\ / : * ? " < > |.
+This table is structured as a mapping from
The table can be accessed via direct iteration as a collection of KeyValuePairs, or by traversal of the stored keys
+ obtained from GetKeys(), or via specific lookup of a key constructed externally. In all cases, the
+
+ The total number of control points must equal numControlPtsU times numControlPtsV,
+ where numControlPtsU and numControlPtsV are the numbers of control points in u and v directions,
+ and they must satisfy the following conditions:
+
+ The convention for 2d (idxU, idxV) to 1d (idx) conversion of array indexes: idxV first.
+ That is, idxU is outer loop and idxV is inner loop. In other words,
+ idx = idxU * numControlPtsV + idxV.
+
Each numbering schema is applicable to a certain category of Revit elements. For example, the Rebar + numbering schema (built-in) is used and only applicable to Rebar elements. With that schema present, + all Rebar elements automatically will get their respective numbers and those numbers would not correspond + in any way to numbers of other enumerable elements that belong to different numbering schemas.
+There are only built-in schemas available currently.
+Elements will be added to the sequence by changing the value of their + Partition parameter. The difference between this method and changing the + parameter value explicitly is that the method here causes sequences to get assigned + and renumbered automatically and immediately without needing to commit a transaction first.
+A numbering sequence for the given partition does not need to exist yet; + it will get created automatically by this method as needed.
+The elements' numbers are likely to be affected by this operation, which is to be + expected. The values of assigned numbers will depend on whether the given sequence + already exists or not. In both cases the elements will get renumbered in order of their + original creation, but the first value will be 1 if the sequence does not exist yet, + respectively the next highest number if the sequence does exist already. The general + matching policy is always applied causing matched elements to have the same number.
+A special case is considered when the given elements are all the elements
+ of one sequence and are being assigned to a sequence that does not exist yet.
+ Such an operation is identical in effect to the
Upon a successful merge, all elements in the new merged sequence + will be renumbered in order of the element creation. There will be no gaps.
+There must not be a sequence for the target partition in the schema yet, + otherwise an exception will be thrown.
+This operation modifies the Partition parameter of all elements + in the sequences that are being merged. Therefore, all its elements + must be accessible for editing, otherwise this operation will fail.
+All numbers assigned to elements in the target sequence remain the same, + but numbers in the source sequence (the one getting appended) will change. + Elements that match elements in the target sequence will get the same + numbers assigned. Remaining elements will get consecutive numbers in the + creation order of the elements starting with the next highest + number available in the target sequence.
+This operation modifies the Partition parameter of all elements + in the sequence that is getting appended. Therefore, all its elements + must be accessible for editing, otherwise this operation will fail.
+Elements can be appended only to a sequence that already exists. In order to
+ reassign elements of one sequence to a partition that does not exist yet,
+ use either the
All numbers assigned to elements in the sequence remain the same.
+This operation modifies the Partition parameter of all elements + in the given sequence. Therefore, all the elements must be accessible + for editing.
+Elements can be moved only to a partition that does not exist yet. To move elements
+ to an existing partition use the
Leading and trailing white space is ignored in the given string and will be + removed automatically.
+This method gives the caller the ability to overwrite any number used in a given + numbering sequence as long as the new number does not exist in the same sequence yet. + If an attempt is made to replace a number by another that already exists, an exception + will be thrown.
+The new number will automatically be applied to all elements that bear the original + number, thus those elements must be free to be modified. A collection of element Ids + of all the affected elements is returned by this method.
+The method is independent of the sequence's current starting number that might have + been assigned previously, meaning that the new number will be accepted even if it is + lower than the previously set start number in the sequence.
+A shift of all numbers in the sequence will be computed and applied + so the first (lowest) number in the sequence would have the given value. + All the other numbers will then be shifted relatively by the same amount.
+Any existing gaps in the current numbering sequence will be preserved.
+Shifts that would make the start number less than 1 or bigger than
+
Numbers are returned as a collection of ranges, where each range + is a pair of two integer values, Low and High. As long as there is + no gap currently in the sequence, there will be only one range.
+The collection may be empty if there are no elements yet in this schema.
+One of the strings can be an empty string, which would indicate presence + of the default partition into which elements automatically belong if left + unassigned to any other partition
+Valid values range from 1 to 10. Numbers with fewer digits + than the minimum number will be padded with leading zeros.
+The value affects all numbering schemas. Thus, once set, numbers for + Rebar and Reinforcement Fabric will be formatted with the same minimum number of digits.
+The current value can obtained by invoking the
The number is used by all numbering schemas in the document.
+The value can be modified by using the
Values of numbers can be obtained by querying this parameter for the respective numbered element. + The value is read-only and thus cannot be set; it is always computed based on the order of created + elements and the matching policy within each numbering sequence.
+
+ Note: Although the parameter cannot be changed directly, it can be modified indirectly
+ (with restrictions) using the
Each NumberingSchema controls numbering of elements of one particular kind, typically of the same category such
+ as Rebar or Fabric Reinforcement. Instances of NumberingSchema are also elements and there is always only one of
+ each type in every Revit document. Available types of all built-in numbering schemas are enumerated in
+
Elements (e.g. Rebar) belonging to a particular schema (e.g. NumberingSchemaTypes.StructuralNumberingSchemas.Rebar) + are organized and numbered in sequences. A sequence is a collection of elements that share the same numbering partition + as defined by their respective values of the Partition parameter (NUMBER_PARTITION_PARAM). For a numbering sequence + to exist it must contain at least one element. In other words, a sequence is established once there is at least + one element of which the partition parameter has a value that differs from other elements (in the same numbering schema). + If the last element is removed (deleted or moved to a different sequence) the then empty sequence ceases to exist.
+Elements get assigned to sequences either upon their creation (based on the then current numbering partition value), + or by explicitly modifying the Partition parameter of an element, or by using the AssignElementsToSequence method. + It is highly recommended using that method over explicitly changing the Partition parameter, because the methods applies changes + to sequences and element numbers immediately, while changed parameters get into effect only after the current transaction is closed.
+In addition to directly or indirectly changing the Partition parameter of elements, numbering sequences can be
+ reorganized by using methods of the NumberingSchema class. The
Elements in different sequences are numbered independently, meaning that there may be elements with the same + number in two sequences even though the elements are different. Likewise, there may be perfectly identical + elements in two or more sequences bearing different numbers. However, within each one numbering sequence any + two identical elements will always have the same number, while different elements will never have the same + number within a numbering sequence. Revit refers to this rule as the matching policy.
+Enumerable elements are always numbered automatically upon their creation. Each new element will get an
+ incrementally higher number. However, thanks to the matching policy, new elements that match existing elements
+ within the same sequence will get the same number assigned. Elements will keep their assigned numbers as long
+ as it is possible. This means, for example, that if some previously created elements (e.g. Rebar) get deleted,
+ all remaining elements (within the same numbering sequence) will keep their numbers, which may result in gaps in
+ the respective numbering sequence. Gaps can be removed by invoking
Numbers are stored as values of a numbering parameter on each numbered element. The Id of the parameter is obtained
+ by querying the
Even though numbers are always assigned automatically to all elements of a schema, the method
+
This element represents a value of a FamilyType Parameter of a Loaded Family. + Each such element corresponds to a nested FamilyType Element in the original + Family Document where the family was defined.
+This element stores only basic information about the nested FamilyType, + such as the name of the Type, name of the Family, and a Category.
+These elements are very low-level and thus bypassed by standard element
+ filters. However, it is possible to obtain a set of applicable elements
+ of this class for a FamilyType parameter of a family by calling
+
This routine is similar to System.String.Compare(), but uses Revit rules for comparison. This involves
+ breaking the names into alphabetic and numeric tokens and comparing tokens individually. Neither comparand is
+ allowed to be
Note that this routine does consider case in comparing names. Some Revit element types disallow assignment + of names where the only difference with existing names is the case of one or more characters, while other + element types do not have this restriction. This routine does not take the particular element type into + account, so it may not identify all "duplicates" if the names are to be used for some element types. + Attempting to set the name on the target Element should provide the final indication of whether it is valid. +
+This function will overwrite the existing TransmissionData + in the file.
+This function will not support models on Revit Server. References + may be to Revit Server, but the host model must be local.
+This function must be called on a closed document.
+This function cannot be used to convert a reference from + a local file to an external server.
+TransmissionData stores information on both the previous state + and requested state of an external file reference. + This means that it stores the load state and path of the reference + from the most recent time this TransmissionData's document was opened. + It also stores load state and path information for what Revit should + do the next time the document is opened.
+As such, TransmissionData can be used to perform operations on external + file references without having to open the entire associated Revit + document. The methods ReadTransmissionData and WriteTransmissionData + can be used to obtain information about external references, or to + change that information. For example, calling WriteTransmissionData + with a TransmissionData object which has had all references set to + LinkedFileStatus.Unloaded would cause no references to be loaded + upon next opening the document.
+TransmissionData cannot add or remove references to + external files. If, on file open, Revit discovers information + in the TransmissionData which does not correspond to an + existing external file reference, + the information will be ignored on file load.
+The TransmissionData for a document does not contain information + about references which come from external servers. TransmissionData only + contains references to local files or Revit links on Revit Server. + TransmissionData cannot + be used to change a reference from a local file reference to an external + server reference.
+Note that TransmissionData objects must be set to "transmitted" for + the requested reference data to be meaningful. Revit ignores the + TransmissionData for non-transmitted files. Marking a file as + transmitted has other effects - workshared files are opened as + detached from the central model, and creation of new local files + is prohibited, until the file is in its final location and the + file has been marked as no longer transmitted.
+ Before you transform a model point to view projection space using the transform returned by
The boundary is one enclosed region of the view's crop.
+For uncropped views 'null' is returned.
+For cropped views that do not have split crop regions, the boundary is the shape of the view crop. Typically the boundary is + rectangular, but more complex shapes are supported.
+For cropped views that have split crop regions, the boundary is one rectangular region of the split view crop.
+ Even though the boundary represents the view crop - a 2D polygon drawn on the view's cut plane - any point in 3D model space
+ that can be seen through the boundary when looking in the direction of the view (see
To test if a point in 3D model space is within the boundary, first project the point and the CurveLoop onto a + plane which is perpendicular to the view direction. Then use a point-in-polygon algorithm to check if the projected + point is inside the polygon described by the CurveLoop.
+ It is guaranteed that the boundary CurveLoop lies on a plane which is perpendicular to
The transform can be used to transform points from model space to view projection space.
+Model space is the global 3D coordinate space in which the 3D geometry of the model lives.
+View projection space is the 3D Euclidean space with a coordinate system such that + X and Y are horizontal and vertical directions in the view projection plane and Z + is the cross product of X and Y. Distances in the projection space are the same as + would be measured on paper if the view is printed without additional scaling.
+For uncropped views all model space points can be transformed to projection space using + the this transform.
+ For cropped views only model points which lie inside the boundary returned by
Use the model-to-projection transform returned by
For views that are placed on sheets, you can combine the View's model-to-projection transform and the Viewport's + projection-to-sheet transform to transform model points to sheet space:
+sheetXYZ = projectionToSheetTransform * modelToProjectionTransform * modelXYZ
+Model space is the global 3D coordinate space in which the 3D geometry of the model lives.
+View projection space is the 3D Euclidean space with a coordinate system such that + X and Y are horizontal and vertical directions in the view projection plane and Z + is the cross product of X and Y. Distances in the projection space are the same as + would be measured on paper if the view is printed without additional scaling.
+Sheet space is the coordinate space of one sheet. This is the space in which viewports and + titleblocks are arranged on the sheet.
+Note that once a group is rolled back, the undone transactions cannot be redone.
+RollBack can be called only when all inner transaction groups and transactions are finished, + i.e. after they were either committed or rolled back.
+After a successful assimilation the transaction group is committed.
+All transactions committed inside this group will be merged into one + single transaction. The resulting undo item will bear this group's name.
+Assimilate can be called only when all inner transaction groups and transactions + are finished, i.e. after they were either committed or rolled back.
+Committing a group does not change the model. + It only confirms the commitment of all inner groups and transactions.
+Commit can be called only when all inner transaction groups and transactions are finished, + i.e. after they were either committed or rolled back. If there is still a transaction or an inner + transaction group open, an attempt to commit this outer group will cause an exception.
+A transaction group controls whether transactions committed inside the group should + stay committed or should be all discarded. If the group is committed, all the transactions + remain committed, but if the transaction group is rolled back instead, all the inner, + already committed transactions will be undone (and removed).
+There are two ways of committing a group - Commit and Assimilate. By committing, + all transactions committed inside a group stay as they are, while by assimilating, + all inner transactions will be merged into a single transaction.
+A transaction group can only be started when no transaction is active, + and must be closed only after the last transaction started inside the group is finished, + i.e. after it was either committed or rolled back.
+Transaction groups may be nested inside each other with the restriction + that every nested transaction group is entirely contained (opened and closed) + in the parent transaction group.
+ +If a transaction group was started and not finished yet by the time the TransactionGroup object
+ is about to be, the default destructor will roll it back automatically, thus all
+ changes made to the document while this transaction group was open will be discarded.
+ It is not recommended to rely on this default behavior though. Instead, it is advised
+ to always call either
This is the mid-point of the leader and its purpose depends on the + shape of the leader. For arc-shaped leaders it defines the radius + of the arc. For a kinked leader it divides the leader line and + shoulder line.
+Note that straight-line leaders do not have an actual elbow; however, + the value can still be obtained, although it will always equal the current + anchor point. Consequently, an elbow point can be set even on a straight-line + leader, but doing so will automatically change the leader's shape property.
+It is allowed to set the Elbow point of a kinked leader to equal either + the end point or anchor point of the leader. Doing so will effectively + change the leader's shape to a straight line. However, the elbow of an arc + leader is never allowed to be placed on either the end or anchor point.
+As a view-specific element the text note will be visible only in the specified view.
+The new text note will be created using the give text type, which defines the style. + The currently default style can be obtained from the Document.GetDefaultElementTypeId method.
+Note that the position's relation to the text's bounding box depends on the requested text alignment + (set via the Options argument). It will be the box' top-left corner for a left-aligned text, + the top-right corner for a right-aligned text, and middle-top point if the text is to be centered.
+ + Width [ft] of the text in paper space (i.e. as it is measured when printed.) + If a line of text is longer than the given specified Width, the text will be automatically wrapped. + If a a zero Width is supplied then this method will create an unwrapped text note element. + + + Text to populate the text note with. + + + Options to control behavior and appearance of the text note. + +As a view-specific element the text note will be visible only in the specified view.
+The new text note will be created using the given text type, which defines the style. + The currently default style can be obtained from the Document.GetDefaultElementTypeId method.
+For a left-aligned text (default), the origin is set at the top-left corner of the note's bounding box.
+ + Width [ft] of the text in paper space (i.e. as it is measured when printed.) + If a line of text is longer than the specified Width, the text will be automatically wrapped. + If a a zero Width is supplied then this method will create an unwrapped text note element. + + + Text to populate the text note with. + + + Id of the text type to use for the new text note. + The text type allows its font name parameter to be set to a font unavailable on the current system. + However, any text note created with or set to this font type will be displayed in a default substituted font (e.g. Arial) + and the UI will show a blank value in the text type font name parameter. + Once the document is opened on a system which has the font set on the text type, + the text note will display with that font and the UI will show that font in the text type font name parameter. + +The new text note will consist of a single line of text unless there + are line-break characters (CR) in the given string. Once the text note is + created its width gets adjusted to fit the longest (or the single one) line of text. +
++ As a view-specific element the text note will be visible only in the specified view. +
++ The new text note will be created using the given text type, which defines the style. + The currently default style can be obtained from the Document.GetDefaultElementTypeId method. +
+Note that the position's relation to the text's bounding box depends on the requested text alignment + (set via the Options argument). It will be the box' top-left corner for a left-aligned text, + the top-right corner for a right-aligned text, and middle-top point if the text is to be centered.
+ + Text to populate the text note with. + + + Options to control behavior and appearance of the text note. + +The new TextNote will consist of a single line of text unless there + are carriage return ('\r') or vertical tab ('\v') characters in the given string. Once the text note is + created its width gets adjusted to fit the longest (or the single one) line of text.
+As a view-specific element the TextNote will be visible only in the specified view.
+The new TextNote will be created using the given text type, which defines the style. + The currently default style can be obtained from the Document.GetDefaultElementTypeId method.
+For a left-aligned text (default), the origin is set at the top-left corner of the note's bounding box.
+ + Text to populate the text note with. + + + Id of the text type to use for the new text note. + +The property controls the vertical position of leaders attached to the right side of the note.
+Change of the value will affect all leaders currently attached to the right side.
+The property controls the vertical position of leaders attached to the left side of the note.
+Change of the value will affect all leaders currently attached to the left side.
++ A flag identifying whether text-wrapping is currently active in this text element or not. +
++ If text wrapping is active the width of the text box remains constant and the text will wrap. + The height of the text box will automatically adjust to accomodate the height of the text. +
+
+ If text wrapping is not active the text does not wrap and the width of the text box adjusts with
+ the width of the longest line of text.
+ As the text width changes, the position of the text may change depending on the
+
This is currently a read-only property and its value is set when the text element + is created. If the element was created with a specified width or if an explicit width + was set later, the wrapping would be automatically set as active. It means that any text + line that is longer that the current width of the text-box will automatically wrapped + onto the next line.
+If the property is True then the text inside the text box gets oriented + so it is readable when looking straight up at the sheet or from its right side; + in other words, the text would never be upside down.
+If the value is False, however, the text's orientation strictly follows + the rotation of the text box, which means the text may be upside down when + viewed on screen or printed on a sheet.
+If a new text content is set, all previous formating that might have been + set on parts of the original text will be lost. After setting the new text, + only the formating parameters of the associated text type will be applied.
+The value of this property can also be accessed via the TEXT_TEXT + Built-In parameter.
+The position defines a point on the edge of the text area, + not a point on the border (if a border is defined for the style.) + It means that if the width of the border gets changed, the + position of the text area remains unchanged.
+The relation of the position point with respect + to the text area depends on the text alignment as follows:
+This property supersedes the older
The value is in sheet units, meaning it is as when measured on a printed sheet. + The measurement is of the text content only; the border around it (if specified) is excluded.
+For a text element which does is set not to use text wrapping the width is calculated + to fit the longest line (a single line, typically) of the text. A setting the width explicitly + by assigning value to this property will automatically activate text-wrapping for the element.
+The value is in sheet units, meaning it is as when measured on a printed sheet. + The measurement is of the text content only; the border around it (if specified) is excluded.
+This is a read-only property, for the height of the text area + is calculated depending on the text content and its wrapping.
+This vector points up from the base of the letters + and is always perpendicular to the base direction. + Those two vectors together define the plane of the text.
+Base direction is always perpendicular to Up direction. + Those two vectors together define the plane of the text.
+Not every mode is available in all views at all times. + Some of the modes are only available in certain views, + or only at certain time/context. Modes that are not available + will not be visible on the view's tool bar in the UI.
+Even modes that are available do not have to be currently
+ enabled in the current context. Before using a mode its
+ applicability should be tested by calling
+
Newly opened views which can have both Cut and Uncut preview will use
+ this default cut/uncut state as long as the default On state is set to True.
+ To control the default state of the PreviewFamilyVisibility in all views refer to
+ the
The settings is applicable to the whole application rather than to + individual family documents; the value persists between Revit sessions. + Although the value is allowed to be set at any time, any changes made after + the Revit application has been initialized will not have effect until the next + session of Revit.
+After a view is opened with the default family preview state applied,
+ its PreviewFamilyVisibility mode may be independently modified through the
+
This flag controls whether each newly opened view is to have the
+ PreviewFamilyVisibility mode turned On by default or not. This property is applicable to all
+ types of views. Views that support both Cut and Non-cut preview (such as floor plans) can be
+ controlled further via the
The settings is applicable to the whole application rather than to + individual family documents; the value persists between Revit sessions. + Although the value is allowed to be set at any time, any changes made after + the Revit application has been initialized will not have effect until the next + session of Revit.
+After a view is opened with the default family preview state applied,
+ its PreviewFamilyVisibility mode may be independently modified through the
+
The state of the PreviewFamilyVisibility mode can be set only if the mode
+ is currently available and enabled in the view. Even in such a condition,
+ however, not all states are valid in all views. To ensure that the state
+ to be applied is valid in the view, call the
Even views which generally support temporary modes will have this particular + mode available only when the document of the view is in the environment of the + family editor.
+This property affect only the view associated with this instance of TemporaryViewModes.
+ When a view is opened for the first time, its state of the PreviewFamilyVisibility mode
+ is determined based on the default settings which is controlled through the properties
+
The class contains methods and properties to manipulate states
+ of various temporary view modes that may or may not be avilable
+ in any of visible views of a Revit document. The temporary modes are
+ enumerated in the
Every view that supports temporary view modes owns an instance
+ of this TemporaryViewModes class, which can be obtained by
+ accessing the
Multiple temporary view modes can coexist. + Also, TemporaryViewProperties mode can be customized to display custom title and custom color. + Setting custom title and color affects only TemporaryViewProperties mode for the specific view. +
This method can perform drawing an image (supplied by the caller) as an in-canvas control in the view(s). The control can react on click
+ by invoking a callback defined in
+ The graphics created by this class are temporary or transient. They are not subject to undo and are not saved. It's caller's + responsiblity to manage their lifetime, creation and destruction, though Revit will destroy all of them when closing the model. +
+This value is used to change the size of text fonts in tabular views, and then the size of rows, colums and cells + will also be changed to satisfy the text.
+Note: This value is only used to improve the text readability in tabular view and will not change the size of texts, rows, columns and cells in sheet views.
+Note: This value is temporary setting just for this session.
+Note: This value is a percentage number which must be a multiple of 10 in the range of 10 to 400. + A value of 400 indicates the maximum zoom permitted. The default value for new created tabular views is 100.
+If you have an active iterator to this collector it will be stopped by this call.
Developers can assign a condition to filter the worksets that are returned. + If no condition is applied, it attempts to access all the worksets in the document.
+The collector will reset if you call another method to + extract worksets. Thus, if you have previously obtained an iterator, it will be stopped and traverse no more + worksets if you call another method to extract worksets.
+There is a small subset of Element subclasses in the API that are not supported + by this filter. These classes exist in the API, but not in Revit's native object model, + which means that this filter doesn't support them. In order to use a class filter to + find elements of these types, it is necessary to use a higher level class and then + process the results further to find elements matching only the subclass. For a list + of subclasses affected by this restriction, consult the documentation for ElementClassFilter. +
If you have an active iterator to this collector it will be stopped by this call.
Elements that will be passed by the collector have graphics that may be visible in + the input view. Some elements may still be hidden because they are obscured by other elements.
+For elements which are outside of a crop region, they may still be passed by the collector because + Revit relies on later processing to eliminate the elements hidden by the crop. + This effect may more easily occur for non-rectangular crop regions, but may also happen even for rectangular crops. + You can compare the boundary of the region with the element's boundary if more precise results are required.
+Accessing these visible elements may require Revit to rebuild the geometry of the view. + The first time your code constructs a collector for a given view, or the first time + your code constructs a collector for a view whose display settings have just been changed, + you may experience a significant performance degradation.
+Developers can assign a variety of conditions to filter the elements that are returned. + This class requires that at least one condition be set before making the attempt to access the elements.
+Revit will attempt to organize the filters in order to minimize expansion of elements regardless of + the order in which conditions and filters are applied.
+There are three groups of methods that you can use on a given collector once you have applied filter(s) + to it. One group provides collections of all passing elements, a second finds the first match of the given + filter(s), and a third provides an iterator that is evaluated lazily (each element is tested by the filter + only when the iterator reaches it). You should only use + one of the methods from these group at a time; the collector will reset if you call another method to + extract elements. Thus, if you have previously obtained an iterator, it will be stopped and traverse no more + elements if you call another method to extract elements.
+In .NET, this class supports the IEnumerable interface for Elements. You can use this class with + LINQ queries and operations to process lists of elements. Note that because the ElementFilters + and the shortcut methods offered by this class process elements in native code before their + managed wrappers are generated, better performance will be obtained by using as many native filters + as possible on the collector before attempting to process the results using LINQ queries.
+One special consideration when using this class in .NET: the debugger will attempt + to traverse the members of the collector because of its implementation of IEnumerable. You may see strange + results if you also attempt to extract the first element or all elements from the collector while the debugger + is also looking at the contents of the collector.
+For any parameter, only one of isStringValueSupported, isDoubleValueSupported, + isIntegerValueSupported, isElementIdValueSupported will return true. No attempt + to convert between types is made. For example, calling GetStringValue, passing + the identifier of a numeric-typed parameter will give an empty string. No + exception will be thrown, and ParameterValueProvider will not attempt to convert + the numeric value to a string.
+If an element doesn't have the requested parameter or the element's parameter doesn't have a valid value,
+ ParameterValueProvider will attempt to get the parameter value from the element's type -
+ see
The triangulation consists of a number of TriangulatedShellComponents. + For a solid, there will be one TriangulatedShellComponent for each component + of the solid's boundary. For example, a solid cube has just one boundary component + (containing six faces), so there will be just one TriangulatedShellComponent. A solid + consisting of two disjoint cubes has two boundary components (the boundaries of the + two cubes), so there will be two TriangulatedShellComponents. A solid consisting of a + sphere with a round void (or hole) inside it also has two boundary components (the + outer sphere and the inner sphere), so there will be two TriangulatedShellComponents. +
+For a shell, there will be one TriangulatedShellComponent for each component of + the shell. +
+Note that this class does not contain information on the containment structure + of the boundary components of a solid. +
+Be careful not to confuse the components of a solid with the solid's + boundary components. This class deals only with the boundary components. +
+When using shared coordinates, ProjectLocations can be used to specify + specific locations for instances of a linked model. A ProjectLocation + keeps track of the position of an instance in relationship to the project's + SiteLocation.
+By default, each Revit project contains at least one named location, called Internal. + Existing ProjectLocation objects can be found by using the ProjectLocations property on + the Document object. New project locations can be created by duplicating an existing project + location using the Duplicate method, and modifying the location's project position.
+ See also+ The indent level is the number of tab stops by which each paragraph will be indented. +
+
+ Note that adjoining paragraphs that have the same indent level
+ and have a list type other than
+ This function applies the nesting level to all paragraphs contained in the given range.
+ The level set on the paragraph cannot be negative and cannot be larger than the value returned by
+
+ List start number is the number of the first paragraph in a numbered list. +
+
+ List start number can be set on paragraphs of type
+ For paragraphs of type
+ Adjoining paragraphs which have a list type other than
+ This function applies the list start number to the given range.
+ The list start number must be in the range given by the methods
+
+ This function applies the
+ The following
+ Set the list type to
+ The list type cannot be set to
+ Paragraphs with a
+ Consecutive list paragraphs with the same indentation level are treated as part of the same list.
+ A list ends when a list paragraph is followed by
+
+ Note that a list will continue uninterrupted after list paragraphs that have higher indentation level.
+ These paragraphs are considered a 'sub-list'.
+ Using
+ FormattedText will keep lists consistent. + That means that numbered paragraphs will automatically get sequential numbers or letters. + It also means that if the list type of one paragraphs in the list + is changed then that change is propagated to all the paragraphs in that list. + Even if those paragraphs were not in the input text range. + Note that this will not affect the list type of any nested sub-lists. +
++ Use a vertical tab character ('\v') to insert a line without a bullet or number. + Since this does not end the paragraph this will allow the list to continue to the next paragraph. +
++ Removing the all caps status will revert the characters back to their + original case. It will not make them lower case. +
++ The given text range should not be empty. +
++ Superscript and subscript are mutually exclusive. + Applying the superscript status will automatically remove the subscript status. +
++ The given text range should not be empty. +
++ Superscript and subscript are mutually exclusive. + Applying the subscript status will automatically remove the superscript status. +
++ The given text range should not be empty. +
++ Bullets, numbers, or letters of a list can not be underlined. +
++ The given text range should not be empty. +
++ To make the numbers or letters in a list italic, apply the italic status to + the carriage return character that ends the list paragraph. +
++ The given text range should not be empty. +
++ To make the numbers or letters in a list bold, apply the bold status to + the carriage return character that ends the list paragraph. +
++ The given text range should not be empty. +
+
+ An instance of FormattedText can be obtained from a
+ It is also possible to create a new instance of FormattedText and assign it
+ to a
+ Formatted text can be used to:
+
+ Formatted text can be populated with plain text by using its
+ constructor
+ In addition, selected ranges of text can be added, removed, or replaced with the
+
+ Use the
+ Formatted text can have up to 30,000 characters. + All characters, except the linefeed character ('\n'), are allowed. + This means that you should not use the 'Environment.NewLine' property, since that includes a linefeed character. + Use the carriage return character ('\r') to terminate a paragraph. + And use a vertical tab character ('\v') to create a new line without terminating the paragraph. +
+
+ Formatted text allows for individual characters to be formatted.
+ The following formatting can be applied.
+
+ Use
+ Use
+ Text can be broken up in paragraphs. Paragraphs are terminated by a carriage return character ('\r'). +
+
+ Each paragraph can be indented several levels deep.
+ For each additional level the indentation increments by one tab size.
+ The total indentation is the product of a tab size and the indent level.
+ Use
+ Note that the tab size is determined by the object that will contain the FormattedText. +
+
+ In the case of a
+ In the case of a
+ Formatted text can also be used to create numbered or bulleted paragraphs with the
+
+ The following
+ Paragraphs with a
+ Note that a list will continue uninterrupted after list paragraphs that have higher indentation level.
+ These paragraphs form a 'sub-list' of the list they interrupt.
+ Sub-lists can have their own sub-sub-lists.
+ The nesting level is only limited by the maximum indent level.
+ Using
+ FormattedText will keep lists consistent. + That means that list paragraphs will automatically get sequential numbers or letters. + It also means that if the list type of one of the paragraphs in a list + is changed then that change is propagated to all the paragraphs in that list. + Note that this will not affect the list type of any nested sub-lists. +
++ Use a vertical tab character ('\v') to insert a line without a bullet or number. + Since this does not end the paragraph this will allow the list to continue to the next paragraph. +
+This transform accounts for the position and rotation of a + viewport on a sheet.
+ The transforms from the model space to the view projection space
+ are returned by
+ Depending on the shape of the argument, view's crop is set to be either rectangular or non-rectangular. + If the crop is set to be rectangular and it is also split, then the multiple view regions will be displayed for the view, + with the same proportions as the split prior to the change, but adjusted to the new rectangular shape. +
+
+ This Method is reserved for setting crop shape in views that allow non-rectangular crop shapes - see property
+ This class manages all the settings that make up the model and annotation crop geometry for a given view or reference callout.
+ You can obtain the settings for a view from
+ The model crop region crops model elements, detail elements (such as insulation and detail lines), section boxes, + and scope boxes at the model crop boundary. + Visible crop boundaries of other related views are also cropped at the model crop boundary. + The model crop region can be set as a polygonal boundary, a rectangular boundary, + or rectangular boundary with one or more splits applied either horizontally or vertically. + If a split is applied to the rectangular crop each resulting rectangular region is identified by a region index and occupies + a percentage of the original crop rectangle. The regions may possibly be moved relative to one another. +
++ The annotation crop region fully crops annotation elements when it touches any portion of the annotation element, + so that no partial annotations are drawn. + Annotations (such as symbols, tags, keynotes, and dimensions) that reference hidden or cropped model elements do not display in the view, + even if they are inside the annotation crop region. + The annotation crop region is always rectangular and at minimum occupies the same area as the rectangular model crop + (or the corresponding rectangular boundary around the non-rectangular model crop), + but can be offset to be bigger than the model crop in order to display more annotations. +
+The input status indicates whether the tangent join is to be locked or unlocked. + Note that the status can be set only if this and the other curve element are currently + joined and tangent at the given point.
+Locking a tangent join between elements of a family will make the family parametric.
+ A parametric family needs to utilize a geometry solver in order to determine final
+ shapes of its instances. Using the solver in families which contain large sketches
+ may cause regenerations of such families to become significantly slower.
+ To determine whether a particular family falls into such a category, programmers
+ can query
A property that returns the time zone in which the site resides. + The value is in hours, ranging from +12 hours to -12 hours with 0 being GMT. + If the input value is not in the valid range, it will be shifted by multiples + of 24 until it is in range.
+Set this property directly if for your desired latitude and longitude, Revit's calculation + does not match with the actual time zone for your location. Note that there are no restrictions + preventing you from setting this to an incorrect value for the site location, and incorrect + times for Solar Studies may result.
+A property that contains the longitude of the site location. + The value of this property is in radians between +PI and -PI. If the given value is + not between -PI and PI, it will be shifted by multiples of 2PI until it is in range.
+When setting this property:
+
A property that contains the latitude of the site location. + The value of this property is in radians between +PI/2 and -PI/2.
+When setting this property:
+
The references must pass the following requirements to be added:
+
+ If any of the above rules is not fulfilled, the execution will be stopped and an exception will be thrown
So far, only bitmap file is supported for
In cases, where a nested structure of several links were loaded, this + method is intended to be a convenient way for IExternalResourceUIServers to + determine whether a top-level link, or any sub-link, which failed to load + properly was provided by their IExternalResourceServer or another server.
+If this link and all nested links loaded successfully, then an empty list is returned.
+A map from nested link paths to the load results for + that nested link.
+For links from external servers, the "path" will be + the display name of the link.
+In the case where there are multiple matches, then the LinkLoadResult closest + to the top-level link will be returned. For example, if you are searching for C, + starting with a top-level link, A, which links B and C, while B also links C directly, + then the load results for C as a direct sub-link of A will be returned. It is expected + that the LinkLoadResults for all instances of C in the nested load result tree will be + the same. However, if you need to inspect each individual result, the LinkLoadResult + class does provide methods to navigate the tree.
+NULL is returned if a match for the ExternalResourceReference cannot be found.
+This function creates a new 3DM link type as well as a new instance of this 3DM link type. + The new instance of 3DM link type is returned by this function and the element id of the new 3DM link type + is contained in the LinkLoadResult.
+If the given external resource reference of the 3DM link is already used by an existing 3DM link type, + a new instance of this existing 3DM link type is created and returned. The element id of the existing + 3DM link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+This function creates a new STL link type as well as a new instance of this STL link type. + The new instance of STL link type is returned by this function and the element id of the new STL link type + is contained in the LinkLoadResult.
+If the given external resource reference of the STL link is already used by an existing STL link type, + a new instance of this existing STL link type is created and returned. The element id of the existing + STL link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+This function creates a new SKP link type as well as a new instance of this SKP link type. + The new instance of SKP link type is returned by this function and the element id of the new SKP link type + is contained in the LinkLoadResult.
+If the given external resource reference of the SKP link is already used by an existing SKP link type, + a new instance of this existing SKP link type is created and returned. The element id of the existing + SKP link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+This function creates a new SAT link type as well as a new instance of this SAT link type. + The new instance of SAT link type is returned by this function and the element id of the new SAT link type + is contained in the LinkLoadResult.
+If the given external resource reference of the DWG link is already used by an existing SAT link type, + a new instance of this existing SAT link type is created and returned. The element id of the existing + SAT link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+This function creates a new OBJ link type as well as a new instance of this OBJ link type. + The new instance of OBJ link type is returned by this function and the element id of the new OBJ link type + is contained in the LinkLoadResult.
+If the given external resource reference of the OBJ link is already used by an existing OBJ link type, + a new instance of this existing OBJ link type is created and returned. The element id of the existing + OBJ link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+This function creates a new DGN link type as well as a new instance of this DGN link type. + The new instance of DGN link type is returned by this function and the element id of the new DGN link type + is contained in the LinkLoadResult.
+If the given external resource reference of the DWG link is already used by an existing DGN link type, + a new instance of this existing DGN link type is created and returned. The element id of the existing + DGN link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+This function regenerates the input document.
+This function creates a new DWG link type as well as a new instance of this DWG link type. + The new instance of DWG link type is returned by this function and the element id of the new DWG link type + is contained in the LinkLoadResult.
+If the given external resource reference of the DWG link is already used by an existing DWG link type, + a new instance of this existing DWG link type is created and returned. The element id of the existing + DWG link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+This function creates a new DWG or DXF link type as well as a new instance of this link type. + The new instance of DWG or DXF link type is returned by this function and the element id of the new DWG + or DXF link type is contained in the LinkLoadResult.
+If the given full path of the DWG or DXF file to link is already used by an existing DWG or DXF link type, + a new instance of this existing DWG or DXF link type will be created and returned. The element id of the existing + DWG or DXF link type is contained in the LinkLoadResult.
+This function regenerates the input document.
+Update the path of the file that specifies the image to be used.
+The provided string path must specify a local file. The path can be absolute or relative + to the project's location.
+Additionally, indicate whether the path used by ImageType should be absolute or relative.
+Update the path of the file that specifies the image to be used.
+The provided string path must specify a local file. The path can be absolute or relative + to the project's location. ImageType will respectively use an absolute or relative path.
++ For raster based image formats (*.bmp, *.jpg, *.jpeg, *.png, *.tif) + the Resolution is used to calculate the size of the image from the number + of pixels in the horizontal and vertical directions. +
++ For PDF files, which have a known paper size, the Resolution is used + to control the amount of detail to capture in the image. + Increasing the Resolution of PDF based images will add more + detail to the image, but will also increase the amount of + data stored in the project file. +
++ The default value of this property is 72 dpi. +
+ImageTypeOptions uses an external resource reference to determine the local path that will be used
+ to open the image file. The operation to obtain the local path requires the resource to be loaded and is
+ performed at a later time when the local path is needed, for example, for validation. See also
+ LoadResource method of
When the provided external resource reference contains a local file path, the information can include + an indication that the path should be treated as a relative path.
+Constructs a new instance of the ImageTypeOptions object.
+The provided string path must specify a local file. The path can be absolute or relative + to the project's location.
+This constructor saves an additional setting that indicates whether the imagetype + will be a link or an import.
+ImageTypeOptions are used to describe how an ImageType should be created from + an image file.
+ImageTypeOptions are used to specify the location of the image file to use for the image
+ using either a string path or an
ImageTypeOptions are used to specify if the file path should be stored as an absolute path, + or a relative path. A relative path is relative to the location of the project file, + unless the file is workshared, in which case the relative path is relative to the location of the central file. + Note that the relative path option is only available if the project file has been saved.
+ImageTypeOptions are used to specify whether the image should be imported or linked. + For imported images the image data is added to the Revit project file. + For linked images the image data is reloaded everytime the project file is opened. + Linked images are only available if they were reloaded successfully, while imported images are always available.
+For PDF files the ImageTypeOptions can be used to specify which page in the PDF file to use for the image. + For raster based image files the page number must be 1 (the default).
+ImageTypeOptions can be used to specify the resolution (in pixels per inch) to use for the image. + For PDF files the resolution is used to determine how many pixels to use + when rasterizing the PDF page. Using a higher resolution will increase the number of pixels. + This will add more detail, but it will also make rendering the image slower. + In addition, it will likely increase the amount of data stored in the project when the image is imported.
+Raster based images have a fixed number of pixels. + As a result, the resolution has no effect on the amount of detail or the amount of data that is stored. + The resolution is only used to determine the size of image. + Doubling the resolution will make the image appear half the size.
+When a file is accessed with the help of an external server, it is likely that a local cache of the file will
+ be created temporarily. ImageTypeOptions may refer to the cached copy of the file internally. For this
+ reason, ImageTypeOptions should be treated as a transient object whose purpose is to become an argument to
+
The ImageType will be created but will not be placed into any view.
+The path string can be in one of several formats:
+ absolute local, relative local, or server (indicating that the file was provided by an external
+ server). The format is determined by
The path can be an empty string, for example for (but not limited to) ImageTypes created using + "Save to Project as Image".
+ImageType elements are created with the ImageType.Create(Document, ImageTypeOptions) method.
+ImageType elements can be loaded from the following file types: *.bmp, *.jpg, *.jpeg, *.png, *.tif.
+In addition, when PDF support is available, ImageType elements can also be loaded from *.pdf files.
+ See:
The linked image could not be loaded from file.
+ Some possible reasons are: +An instance of the implemented interface is passed as an argument to the Document.MakeTransientElements() method, which will call back the Execute method of the interface.
+During the execution of the method Revit will allow creation of certain elements, such as DirectShape, and will make them automatically transient . See (
The code within the Execute method is not allowed to modify the model in any other way. An attempt to change the model or create elements of other kinds will result in an exception. This indirectly means that methods using a transaction internally are not allowed either. Such methods include document Save and SaveAs, certain import and export methods, creating links, syncing with central, etc.
+Regenerating the model is also not allowed for the entire duration of the Execute method.
+This interface is passed to
The input path must be absolute. Revit will store + an absolute or relative path internally, according + to the link's settings. Revit Server paths or cloud paths are acceptable.
+If the link is currently loaded, Revit must unload + the link before reloading it. Any changes made in-memory + to the link's shared coordinates will be discarded.
+Revit does not try to validate that the input path + represents the "same" document. You can load a + completely different document, which may invalidate + references to linked elements.
+This function regenerates the document.
+The document's Undo history will be cleared by this command. + As a result, this command and others executed before it cannot be undone. + All transaction phases (e.g. transactions transaction groups and sub-transaction) + that were explicitly started must be finished prior to calling this method.
+A WorksetConfiguration object indicating which worksets in the + link to open.
+If you want to load the same set of worksets the link previously
+ had, leave this argument as
This function unloads the Revit link for the current user, + instead of all users, in the workshared files.
+ If you want to unload the Revit link for all users, please use
This function should not be called on a Revit link:
+This function will not return nested links.
+Revit will not check the version when checking for + resource equality.
+This function regenerates the document.
+The document's Undo history will be cleared by this command. + As a result, this command and others executed before it cannot be undone. + All transaction phases (e.g. transactions transaction groups and sub-transaction) + that were explicitly started must be finished prior to calling this method.
+The input path must be absolute. Revit will store + an absolute or relative path internally, according + to the link's settings. Revit Server paths or cloud paths are acceptable.
+If the link is currently loaded, Revit must unload + the link before reloading it. Any changes made in-memory + to the link's shared coordinates will be discarded.
+Revit does not try to validate that the input path + represents the "same" document. You can load a + completely different document, which may invalidate + references to linked elements.
+This function regenerates the document.
+The document's Undo history will be cleared by this command. + As a result, this command and others executed before it cannot be undone. + All transaction phases (e.g. transactions transaction groups and sub-transaction) + that were explicitly started must be finished prior to calling this method.
+A WorksetConfiguration object indicating which worksets in the + link to open.
+If you want to load the same set of worksets the link previously
+ had, leave this argument as
If the link is currently loaded, Revit must unload + the link before reloading it. Any changes made in-memory + to the link's shared coordinates will be discarded.
+Revit does not try to validate that the input + represents the "same" document. You can load a + completely different document, which may invalidate + references to linked elements.
+This function regenerates the document.
+The document's Undo history will be cleared by this command. + As a result, this command and others executed before it cannot be undone. + All transaction phases (e.g. transactions transaction groups and sub-transaction) + that were explicitly started must be finished prior to calling this method.
+A WorksetConfiguration object indicating which worksets in the + link to open.
+If you want to load the same set of worksets the link previously
+ had, leave this argument as
Revit can open several documents which contain the same link. If + this is the case, Revit cannot reload the link, as doing + so would make changes to a non-active document. You will need to close + one or more documents in order to modify the link.
+If the link is loaded into multiple documents across multiple sessions + of Revit, this function will return true. We only check the current session + of Revit. It is safe to reload a link which is loaded into multiple + sessions, as long as it is not loaded into more than one document + in any one session.
+If this function returns true, it is safe to reload the link.
+This function removes the local user's override of the link's workshared load status + (see UnloadLocally method). That is, if the link is loaded in the central model for + all worksharing users (and thus has been only unloaded for the local user), then this + method will perform a full reload of the link for the local user. If the link is + unloaded in the central model, then this method will simply clear the local user's + unload override, so that the link will be reloaded in the local user's model, + if it is ever reloaded in the central model.
+This function should not be called on a Revit link:
+If the link is an external resource, Revit will contact the IExternalResourceServer + to get the latest version of the link.
+If the link is currently loaded, Revit must unload + the link before reloading it. Any changes made in-memory + to the link's shared coordinates will be discarded.
+This function regenerates the document.
+The document's Undo history will be cleared by this command. + As a result, this command and others executed before it cannot be undone. + All transaction phases (e.g. transactions transaction groups and sub-transaction) + that were explicitly started must be finished prior to calling this method.
+This function is identical to RevitLinkType.Load() and is included for + convenience.
+If the link is currently loaded, Revit must unload + the link before reloading it. Any changes made in-memory + to the link's shared coordinates will be discarded.
+This function regenerates the document.
+The document's Undo history will be cleared by this command. + As a result, this command and others executed before it cannot be undone. + All transaction phases (e.g. transactions transaction groups and sub-transaction) + that were explicitly started must be finished prior to calling this method.
+This function is one of a series of steps necessary for linking an IFC file. + To understand how it is used in context, please download the IFC open source code, + and look in the Revit.IFC.Import project at Importer.ImportIFC(ImporterIFC importer), + under the IFCImportAction.Link branch.
+ + This function regenerates the input document. + + While the options argument allows specification of a path type, the + input path argument must be a full path. Relative vs. absolute determines + how Revit will store the path, but it needs a complete path to find + the linked document initially. +This function is one of a series of steps necessary for linking an IFC file. + To understand how it is used in context, please download the IFC open source code, + and look in the Revit.IFC.Import project at Importer.ImportIFC(ImporterIFC importer), + under the IFCImportAction.Link branch.
+ + This function regenerates the input document. + + While the options argument allows specification of a path type, the + input path argument must be a full path. Relative vs. absolute determines + how Revit will store the path, but it needs a complete path to find + the linked document initially. +This function regenerates the input document.
+Only the WorksetConfiguration information in the options argument + will be used. The path type information will be ignored.
+"Attachment" links are considered to be part of their parent + link and will be brought along if their parent is linked into + another document. "Overlay" links are only visible when their + parent is open directly.
+ For example: A user has a file B which contains a link C, and + they wish to link B into another file, A. If C is an overlay, C + will not be loaded into A. If C is an attachment, then C will + be loaded into A along with B. +You cannot change the PathType to or from PathType.Server. The + path type will change automatically if you call RevitLinkType.LoadFrom + with a Revit Server path.
+Links from external resource servers are considered to have no path + type. Attempts to access this property for an external server link + will result in an exception.
+This function can fail due to following reasons:
+This function will can fail due to following reasons:
+If the layout rule is Singe or FixedNumber or NumberWithSpacing this function will return true if getNumberOfBarGeometry() is less getBarsNumber(), false otherwise.
+If the layout rule is MaximumSpacing or MinimumClearSpacing this function will return always true.
+This function can fail due to following reasons:
+This function will can fail due to following reasons:
+InteriorFace : rebar to attach to interior face of cover reference.
+ExteriorFace : rebar to attach to exterior face of cover reference.
+This function is supposed to provide the positions of handles defined in GetCustomHandles(). These positions will be shown on screen when the bar constraints are edited. + If a position for a handle isn't provided, that handle will not be represented on screen while edit constraints.
+This function is called when edit constraints command is lunched or during edit constraints after a constraint was changed and the curve calculation was done.
+This function is called in the regeneration context when at least one data in trimExtendData parameter was changed. It is called immediately after GenerateCurves() and only if GenerateCurves() returns true.
+If new constraints were created for start or end handle, a new regeneration will take place and the new constraints will become the rebar's actual constraints.
+If new curves will be added by calling TrimExtendData.AddBarGeometry(), the existing curves in Rebar element will be replaced with these curves. It will not add curves to the existing ones.
+This function is supposed to provide the positions of handles defined in GetCustomHandles(). These positions will be shown on screen when the bar constraints are edited. + If a position for a handle isn't provided, that handle will not be represented on screen while edit constraints.
+This function is called when edit constraints command is lunched or during edit constraints after a constraint was changed and the curve calculation was done.
+This function is called in the regeneration context when at least one data in trimExtendData parameter was changed. It is called immediately after GenerateCurves() and only if GenerateCurves() returns true.
+If new constraints were created for start or end handle, a new regeneration will take place and the new constraints will become the rebar's actual constraints.
+If new curves will be added by calling TrimExtendData.AddBarGeometry(), the existing curves in Rebar element will be replaced with these curves. It will not add curves to the existing ones.
+This interface should be overridden in order to create a free form rebar with constraints and to allow generation and update of its geometry.
+ Once a rebar is created with a server, it will be calledBased on these handles rebar constraints can be defined. Once the constraints are defined a regeneration should be triggered in order to generate the bar geometry.
During the regeneration the functions
Every time when a constraint is modified a new regeneration is triggered and the functions GenerateCurves() and TrimExtendCurves() are called again.
We also can edit constraints for this rebar. When user starts to do this, the function
While editing constraints an user will modify constraints (e.g. add a new reference or remove one) a regeneration will be triggered + and the functions GenerateCurves() and TrimExtendCurves() will be called again.
This class is the start point for engine providers. A custom engine implementation consists of the following:
+
Engine implementations may be file-based or non-file-based:
+
Regardless of the type of engine used, the implementation must supply enough information to Revit to
+ display the contents of the point cloud. There are two ReadPoints methods which must be implemented:
+
An instance of this interface is obtained from the associated point cloud + engine when the engine's CreatePointCloudAccess method is called.
+An instance of this class will be requested by Revit when drawing the point cloud in the view. For performance reasons, + when rendering every frame Revit asks the engine to fetch the necessary points split into multiple batches. + The number of batches requested depends on the view: the smaller the projection of the cloud bounding box on the screen + the fewer batches Revit requests. Revit assumes that each batch contains points uniformly distributed over the visible part of + the cloud ("visible" as defined by the filter). Thus, the points supplied by the engine should not be geometrically distinct (e.g. + divided into multiple independent volumes, because at distant zoom levels Revit will only request a few batches and only part + of the cloud will be displayed.
+Revit documents that are linked into host documents are read-only. If the user wishes to edit a linked Revit file + they can use the "Open (and Unload)" command to unload the link, and automatically load it directly as a top-level, + modifiable document (Revit files cannot be edited while they are being used as links). To support this operation for + Revit links obtained as external resources, IExternalResourceServer authors should implement this callback. They + should return a local path from where Revit can open the linked document for edit. Ideally, this should be a + path that is different than the location from where it has been loaded as a link.
+Once the user opens a link as a top-level document, they will presumably make changes to it and save it. It is + the responsibility of the server to upload whatever changes the user makes so that the version stored on the server + remains the most current. Server providers can determine when changes have been made by the user to local file + by watching for the DocumentSaved event.
+The purpose of this string is to describe the external service + in more details than just a short name alone could do. + The intended use is to show the string to the end user in UI + when UI is appropriate for the service.
+Beside the requirement for it to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework.
+Although an external service is uniquely identified by its Id, the Name + can identify it to the end user in UI when UI is appropriate for the service.
+Beside the requirement for the name to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework.
+For all built-in external services, their Ids are all items + of the enumerated type ExternalServices.BuiltInExternalServices.
+Third-party services will have their respective Ids based on GUIDs. + It is important to note that a service Id must be unique. It will + be an error if two external services try to register with the same Id.
+The purpose of this string is to describe the external service + in more details than just a short name alone could do. + The intended use is to show the string to the end user in UI + when UI is appropriate for the service.
+Beside the requirement for it to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework.
+Although an external service is uniquely identified by its Id, the Name + can identify it to the end user in UI when UI is appropriate for the service.
+Beside the requirement for the name to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework.
+For all built-in external services, their Ids are all items + of the enumerated type ExternalServices.BuiltInExternalServices.
+Third-party services will have their respective Ids based on GUIDs. + It is important to note that a service Id must be unique. It will + be an error if two external services try to register with the same Id.
+For Revit links specifically, Revit will check this value to see + if it should report errors about a given link in the Unresolved + References dialog. An IExternalResourceUIServer can set this value + to true to avoid redundant messages.
+Note that it is possible for Revit to encounter errors internally + even if the server successfully provides a reference. In general, this + value should only be set to true if the server has reported an + error condition.
+This class contains the input and output data resulting from invoking an IExternalResourceServer's LoadResource method.
+After the call to LoadResource, the resulting ExternalResourceLoadData will be passed into + IExternalResourceServer.HandleLoadResourceResults() so that appropriate UI can be displayed.
+Server providers can inspect the ExternalResourceLoadData to get an ExternalResourceLoadContent + object of the subclass appropriate to the external resource. The class also contains a copy of the + ExternalResourceReference, and information about the context of the load operation.
+This class permits assignment of some specific operations related to a type of + external resource, such as what to do when "Open (and Unload)" happens, or when + "Shared Coordinates update" happens for Revit or CAD links.
+There is no feedback to the UI server for ExternalResourceServerExtensions. + Revit will use standard, common message dialogs to handle any error conditions.
+The path stores the full display path which includes the server name plus the path provided by ExternalResourceServer.
+The path that Revit will present for user recognizing and browsing to this resource during one session of Revit.
+This property allows ExternalResourceServers to handle cases where the path to a resource may vary between Revit sessions. + For example, if this ExternalResourceReference refers to a resource in a folder, + this property can be used to store the current path of the resource. If the resource is moved to another folder later, + the ExternalResourceServer could calculate the correct path for the resource from resource identification information + when it is loaded and store it in this property, + so that it will work correctly even if the rvt file is opened in a different location.
+Do not rely on this path to look up an ExternalResourceReference, as the path is neither unique nor stable. It isn't unique + because multiple servers might use the same server name and display name format. It isn't stable because some servers allow renaming, + and because a server might change its name at some point.
+The class contains:
+When calling an IExternalResourceServer, Revit will provide an ExternalResourceReference to + identify the specific resource that Revit is using from that server. The server can then use the + relevant information in the (String, String) maps to retrieve the data from the correct source.
+A server may use to wish this information to, for example, + tell whether the Revit user was previously using their + server or not.
+This reference may be
Note that automatic loads can occur in the context of other operations such as opening a file. + During automatic loads, it is therefore recommended that the server only display UI that is critical + for the user to see (such as error message).
+The loading operation type is Explicit when the user is specifically trying to reload the resource. + During explicit loads, it may be desirable to provide more feedback to the user, such as specific feedback + that the load operation succeeded.
+When its LoadResource() method is invoked, an IExternalResourceServer can + indicate the version of the data that it is providing to Revit by setting + this property. Doing so will improve performance, because Revit will use + the version information to avoid unnecessary reloads.
+See
When Revit calls the LoadResource method for an IExternalResourceServer, Revit will provide an object that is a + sub-class of ExternalResourceLoadContent. The IExternalResourceServer will use this object to return the content + Revit should use for the external resource. The server can also add information about any errors that occurred + during the load operation. This error information will be stored by Revit and later passed to the + associated IExternalResourceUIServer (if any) that designates the IExternalResourceServer as its "DBServer" + (see the IExternalResourceUIServer.GetDBServerId() method). The IExternalResourceUIServer can then generate + any UI that is required for handling the errors that occurred.
+Note that since different kinds of external resources are expected to return different kinds of data to Revit, + a number of ExternalResourceLoadContent sub-classes have been created to handle the data for specific ExternalResourceTypes. + This base class contains only a string to indicate the version of the resource data that is being supplied + by the server and a status variable to indicate the outcome of a load operation. Revit will always + provide the server with an instance of the appropriate sub-class of ExternalResourceLoadContent, with internal + data that are relevant to the particular ExternalResourceType that is being loaded.
+The folder separator should always be "/" and "/" always represents the root folder for the server.
The interpretation of what a folder represents is up to the server. + For example, the folder "/English/Keynote" might be a physical folder on a disk, or a table or key in a database.
+ + The options to match the external resources and folders. +Generally, the returned resources should match the options, otherwise the resource may be regarded + as invalid which may not be available in browser dialogs.
+This data represents the contents to be shown to the user while they are browsing a specific folder in Revit.
+The folder path can be obtained from the
The external resource server is expected to populate all of the available resources and subfolders + that should appear in the Revit file browser while the browser is open to this particular folder.
+If the user navigates to another folder, a different ExternalResourceBrowserData object will be + provided to allow the server to populate resources at that location.
+When adding resource and subfolder, the resource and subfolder should not be added recursively.
+When adding resource and subfolder, the name should be unique short name(without folder).
+The name of resource and subfolder should not contain any invalid character of \/:*?"<>|.
+The length of resource combined path(server name + folder path + resource name) should not exceed 259; + The length of subfolder also has same restriction.
+Through this method, some specific operations for a paritcular type of external resource, such as Open(and Unload) + and shared coordinates for Revit Link, can be set in a class ExternalResourceServerExtensions. +
++ ExternalResourceServerExtensions is able to own sub-interface classes, each of which has methods + related to a particular type of external resource.
+To ensure the server can be registered successfully, the name should match restrictions below:
The specified image will be displayed in the browser dialogs when the user is selecting + a resource of a compatible type.
+The return must be the full path to an icon file containing 48x48, 32x32 and 16x16 pixel images.
+If this method returns anything other than a valid icon file, a default image will be used for the server.
+If Revit already has a version of this resource loaded, Revit will invoke this method
+ to check whether the resource's data will change if
Servers which encounter errors should return ResourceVersionStatus.Unknown. Revit + will reload resources whose version status is unknown, but will not display + out-of-date warnings to the user on printing.
+Different servers will have different requirements.
+A server which loads references from a website might + require that the reference map contain a key called "URL" + and a value that is a valid URL.
+A server which loads references from a network drive + might require a key called "Drive" with a value that + represents a drive name, plus a key called "Path" with + a value that corresponds to a path relative to the root + of the drive.
+This function should not check that the resource exists + on the server. It should only check that the resource is + formatted correctly.
+This method will be invoked when Revit needs to load a resource supplied by this server.
+Revit provides four key pieces of information to the server:
+The server returns the results of the load request back to Revit via the loadResults argument, which will be a + sub-class of ExternalResourceLoadContent. This object will contain appropriate data structures to hold the actual resource + data (content) required by Revit for the specified ExternalResourceType.
+Server authors may also wish to display UI related to the resource load operation, particularly when errors occur while + loading or creating the content. The UI should not be created by the IExternalResourceServer. Instead, the server + author should implement an IExternalResourcesUIServer which will handle all UI-related tasks. The external services framework + supports data sharing between, and coordinates the actions of, the two types of servers as follows:
+Note that instead of using the ExternalResourceLoadContent object, the IExternalResourceServer can store its own error
+ information. Subsequently, when the external services framework invokes the IExternalResourceUIServer's HandleLoadResourceResults
+ method, the IExternalResourceUIServer can communicate directly with its associated IExternalResourceServer - using whatever interface
+ the server developer has implemented - to retrieve the required messages and error data for display in the UI. Revit provides
+ a GUID to
Through this method, some specific operations for a paritcular type of external resource, such as Open(and Unload) + and shared coordinates for Revit Link, can be set in a class ExternalResourceServerExtensions. +
++ ExternalResourceServerExtensions is able to own sub-interface classes, each of which has methods + related to a particular type of external resource.
+To ensure the server can be registered successfully, the name should match restrictions below:
The specified image will be displayed in the browser dialogs when the user is selecting + a resource of a compatible type.
+The return must be the full path to an icon file containing 48x48, 32x32 and 16x16 pixel images.
+If this method returns anything other than a valid icon file, a default image will be used for the server.
+If Revit already has a version of this resource loaded, Revit will invoke this method
+ to check whether the resource's data will change if
Servers which encounter errors should return ResourceVersionStatus.Unknown. Revit + will reload resources whose version status is unknown, but will not display + out-of-date warnings to the user on printing.
+Different servers will have different requirements.
+A server which loads references from a website might + require that the reference map contain a key called "URL" + and a value that is a valid URL.
+A server which loads references from a network drive + might require a key called "Drive" with a value that + represents a drive name, plus a key called "Path" with + a value that corresponds to a path relative to the root + of the drive.
+This function should not check that the resource exists + on the server. It should only check that the resource is + formatted correctly.
+This method will be invoked when Revit needs to load a resource supplied by this server.
+Revit provides four key pieces of information to the server:
+The server returns the results of the load request back to Revit via the loadResults argument, which will be a + sub-class of ExternalResourceLoadContent. This object will contain appropriate data structures to hold the actual resource + data (content) required by Revit for the specified ExternalResourceType.
+Server authors may also wish to display UI related to the resource load operation, particularly when errors occur while + loading or creating the content. The UI should not be created by the IExternalResourceServer. Instead, the server + author should implement an IExternalResourcesUIServer which will handle all UI-related tasks. The external services framework + supports data sharing between, and coordinates the actions of, the two types of servers as follows:
+Note that instead of using the ExternalResourceLoadContent object, the IExternalResourceServer can store its own error
+ information. Subsequently, when the external services framework invokes the IExternalResourceUIServer's HandleLoadResourceResults
+ method, the IExternalResourceUIServer can communicate directly with its associated IExternalResourceServer - using whatever interface
+ the server developer has implemented - to retrieve the required messages and error data for display in the UI. Revit provides
+ a GUID to
Certain resources used in a Revit model are stored outside of the .rvt file. For example, the data used + for keynotes, images used as decals during rendering, CAD links, and Revit links are all stored outside + the model. Creating a new implementation of this server allows the server to supply one or more types of such resources from + an arbitrary source. For example, a server could provide the keynote data from a database or from + a file format that Revit does not support.
+If a model references resources supplied by this server, Revit will request the resource from the server + when it is required. Most external resources are loaded into memory at the time the model is loaded. The + server will also be invoked if the resource is explicitly reloaded.
+IExternalResourceServer can declare that a resource is already up-to-date via
+
Each resource load request will be associated with a GUID, so that server implementers can uniquely identify + a given load request. This may be useful to, for example, store server-side errors associated with an + attempt to load a particular resource.
+If your server handles Revit or CAD links, you must take special care with link paths. When one of these + file types is uploaded to your server, any nested references should be brought to the server along with the + main link. Your server will need to repath any nested reference itself; Revit will not handle this automatically.
+In the case of DWG links, your server will also need to download and possibly repath any xrefs when + LoadResource is called for the top-level link. Revit will only request the top-level link directly.
+ In the case of Revit links, the ExternalResourceReferences for any nested links will also
+ need to be modified in the host document. The host document should reference the Revit links at their
+ server locations, not their local file locations. Revit may not be able to find links if the
+ paths are not set up correctly. See
Here is an example which uses nested Revit links: A user has a Revit model containing one link, Link.rvt, which + contains one nested link, Nest.rvt. The user uploads Link.rvt to a server, using an add-in provided by that + server. The server provider must also take Nest.rvt. Further, the server provider must open Link.rvt and modify + the reference to Nest.rvt so that it references the version on the server. Otherwise, Revit will not be able to + find Nest.rvt when another user tries to load Link.rvt from the server.
+The external resource framework has been designed to allow server authors to display UI related to the resource
+ load operation and UI browse operation. No UI should be displayed directly from an IExternalResourceServer.
+ Instead, developers should create an IExternalResourceUIServer which will handle UI tasks on behalf of the IExternalResourceServer.
+ For more information, see the documentation for the
CameraInfo can be obtained directly from a
+ See also:
+ Output nodes following this node are to be assumed using the material. + The material remains in effect until another material node is sent to the output. +
+
+ See also:
If the property is True then the text inside the text box gets oriented + so it is readable when looking straight up at the sheet or from its right side; + in other words, the text would never be upside down.
+If the value is False, however, the text's orientation strictly follows + the rotation of the text box, which means the text may be upside down when + viewed on screen or printed on a sheet.
+The relation of the position point with respect + to the text area depends on the text alignment.
+For example:
+
+ The value is an integer number in range of [0,15] (inclusive), + or a value {-1}. If the value is positive, Revit will use the + suggested level of detail when tessellating faces; otherwise it will + use its default algorithm, which is based on output resolution. +
++ If an explicit level of detail is requested (i.e. a positive value), + using a value close to the middle of the valid range yields a very + reasonable tessellation. Revit uses level 8 as its 'normal' LoD. +
+Note that this method is invoked only if the custom exporter
+ was set up to include geometric objects in the output stream.
+ See
Note: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
+Note: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
Note that this method is invoked only if the custom exporter
+ was set up to include geometric objects in the output stream.
+ See
Note: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
+Note: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
Note that this method is invoked only if the custom exporter
+ was set up to include geometric objects in the output stream.
+ See
Note: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
+Note: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
Note that this method is invoked only if the custom exporter
+ was set up to include geometric objects in the output stream.
+ See
Note: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
+Note: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
An instance of a class that implements this interface is passed in as a
+ parameter of the
+ With this type of export context used to perform a custom export, + Revit will traverse the model and output the model's geometry + as if in the process of regular displaying or exporting a 2D View. + It means that any geometry which is visible in an open view + (taking any current visibility setting applicable to the view) + will be processed and output. + Optionally, annotation objects are also output.
+
+ Note 1. Curves passed to calls
+ Note 2. If element E is a FamilyInstance and it contains an imported instance then: +
An instance of a class that implements this interface is passed in as a
+ parameter of the
+ With this type of export context used to perform a custom export, + Revit will traverse the model and output the model's geometry + as if in the process of regular displaying or exporting a 3D View. + It means that any geometry which is visible in an open view + (taking any current visibility setting applicable to the view) + will be processed and output.
+An instance of a class that implements this interface is passed in as a
+ parameter of the
+ With this type of export context used to perform a custom export, + Revit will traverse the model and output the model's geometry + as if in the process of regular displaying or exporting a 3D View. + It means that any geometry which is visible in an open view + (taking any current visibility setting applicable to the view) + will be processed and output.
+Note for 2D export: if the export is performed for the view in non-Wireframe display style, then +
Note for 2D export: if the export is performed for the view in non-Wireframe display style, then +
Note for 2D export: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
Note for 2D export: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
Note that this method is invoked only if the custom exporter
+ was set up to include geometric objects in the output stream.
+ See
+ The curve can be one of the geometric object that derive from the Curve class, e.g. Line, Arc, + NurbeSpline, etc. To get to the specific properties of the particular class, the curve + obtained from the input node first needs to be cast accordingly depending on the curve's + actual type. +
+Note for 2D export: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
+Note for 2D export: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
Note for 2D export: if the export is performed for the view in non-Wireframe display style, then +
Note for 2D export: if the export is performed for the view in non-Wireframe display style, then +
Note for 2D export: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
Note for 2D export: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
Note that this method is invoked only if the custom exporter
+ was set up to include geometric objects in the output stream.
+ See
+ The curve can be one of the geometric object that derive from the Curve class, e.g. Line, Arc, + NurbeSpline, etc. To get to the specific properties of the particular class, the curve + obtained from the input node first needs to be cast accordingly depending on the curve's + actual type. +
+Note for 2D export: if the export is performed for the view in non-Wireframe display style + this method will be called regardless of whether the object will be eventially output, + i.e. even if it's occluded by another element.
+Note for 2D export: if the export is performed for the view in non-Wireframe display style + tesselated geometry will be output regardless of the return value.
An instance of a class that implements this interface is passed in as a
+ parameter of the
With this type of export context used to perform a custom export, + Revit will traverse the model and output the model's geometry + as if processing the Render command invoked via the UI. It means + that only such elements that have actual geometry and are suitable + to appear in a rendered view will be processed and output.
+An instance of a class that implements this interface is passed in as a
+ parameter of the
This is a base class for two other interfaces derived from it:
+
Note that the actual export process may differ
+ depending on the type of export context used. For example, when the
+
Note that all views in the collection must be either 3D or 2D views and they must match the exporter context.
+Note that currently the only 2D view types exported are
Note that the actual export process may differ
+ depending on the type of export context used. For example, when the
+
See notes for 2D export for views in non-Wireframe display style in
If geometric objects are to be excluded, the context will not + receive any of the calls to related to Faces or Curves. However, the + objects will be still processed by Revit resulting in exporting their + tessellated geometry in form of polymeshes or lines, respectivelly.
+Regardless of the value of this property, the export context + must always implement the methods related to receiving of geometric + objects (e.g. OnFaceStart, OnFaceEnd, OnCurve, etc.), even though + the methods may never be invoked.
+Setting this property to False allows clients to significantly speed up + the export process. If the export context does not need to examine geometric + objects, it is recommended setting this property to False, which will make + the export process faster even when compared with export during which + notifications about geometric objects are sent, but ignored by the context.
++ The Export method of this class triggers standard rendering or exporting + process in Revit, but instead of displaying the result on screen or printer, + the output is channeled through the given custom context that handles + processing of the geometric as well as non-geometric information. +
+
+ Revit will process the exporting algorithm depending on the type
+ of given context. If an instance of
+ Alternatively, if an instance of
+ For 2D views, an instance of
In the current release servers that use handle elements can only work with internal addins.
+Third-party implementers should return ElementId.invalidElementId.
+In the current release servers that use handle elements can only work with internal addins.
+Third-party implementers should return ElementId.invalidElementId.
+The representation of geometry is in terms of a set of vertex and index buffers. The server can + use facilities in Autodesk::Revit::DB::DirectContext3D::DrawContext to + create the buffers and fill them with data that encode primitives such as triangles, lines, and points. + The server can also adjust the geometry that it submits based on the argument to RenderScene() and in + response to certain rendering parameters whose values are available through DrawContext (e.g., clip planes).
+The final step in the process of submitting geometry for rendering is to call DrawContext::FlushBuffer() + for the appropriate buffers.
+This interface method may be called in a separate thread from the others.
+Transparent geometry is rendered in a separate pass following the opaque geometry. If a server + returns true from UseInTransparentPass(), it can provide geometry for rendering in either pass using + the RenderScene() method. Otherwise, the server will be called to submit only opaque + geometry.
+The server has a way to determine whether it should submit opaque or transparent geometry when + RenderScene() is called + (see Autodesk::Revit::DB::DirectContext3D::DrawContext::IsTransparentPass(void)).
+Revit uses the bounding box when navigating views, e.g., when a Zoom to Fit command is issued. + The reported bounding box does not have to be tight. However, there may be unintended side-effects + if the box is inconsistent with the submitted geometry.
+In the current release servers that use handle elements can only work with internal addins.
+Third-party implementers should return 'false'.
+Execution of a DirectContext3D server means that the server is called upon to contribute a bounding box + and graphics content (opaque and transparent) for an opened view. The following are some of the conditions + that control whether the server is executed:
+The representation of geometry is in terms of a set of vertex and index buffers. The server can + use facilities in Autodesk::Revit::DB::DirectContext3D::DrawContext to + create the buffers and fill them with data that encode primitives such as triangles, lines, and points. + The server can also adjust the geometry that it submits based on the argument to RenderScene() and in + response to certain rendering parameters whose values are available through DrawContext (e.g., clip planes).
+The final step in the process of submitting geometry for rendering is to call DrawContext::FlushBuffer() + for the appropriate buffers.
+This interface method may be called in a separate thread from the others.
+Transparent geometry is rendered in a separate pass following the opaque geometry. If a server + returns true from UseInTransparentPass(), it can provide geometry for rendering in either pass using + the RenderScene() method. Otherwise, the server will be called to submit only opaque + geometry.
+The server has a way to determine whether it should submit opaque or transparent geometry when + RenderScene() is called + (see Autodesk::Revit::DB::DirectContext3D::DrawContext::IsTransparentPass(void)).
+Revit uses the bounding box when navigating views, e.g., when a Zoom to Fit command is issued. + The reported bounding box does not have to be tight. However, there may be unintended side-effects + if the box is inconsistent with the submitted geometry.
+In the current release servers that use handle elements can only work with internal addins.
+Third-party implementers should return 'false'.
+Execution of a DirectContext3D server means that the server is called upon to contribute a bounding box + and graphics content (opaque and transparent) for an opened view. The following are some of the conditions + that control whether the server is executed:
+Returns the MultipleValuesIndicationSettings element in project documents
+ or
+ Only servers that have not been used yet (executed) in any still open document are allowed + to be removed. This applies to servers used in the current session or previous sessions. +
+The service must be declared as public in order for callers be + able to invoke this method. Services that are not public can be + executed only by their owners (the ones who registered it).
+Most services are not public and may only be executed by their + respective owners. To see whether a service was declared as public, + call the GetOptions method and check the IsPublic property.
+This property is ignored unless the service is also recordable.
+Declaring a service as self-synchronizing makes the service bypass standard + worksharing checks during local-central synchronizations. What it means is that + should there be any disparity found between the list of servers used in the local + file and those used in the central file, they would get ignored; it would be + assumed that the owner of the service takes other steps to ensure the local and + the central data are in sync.
+Few services should need to set this property as True, for self-synchronizing + services are very rare, practically limited only to those which operate on element + level.
+When a recordable service is executed in a document, a record about the executed + server (or servers) is stored in the document's history. This allows active servers + to be synchronized next time a saved document is opened in Revit.
+Executions of a recordable service in a document must happen inside a transaction.
+A public service can be executed by anyone, while a private + service can be execute only by the caller who registered it + (the owner of the service, typically), or by someone who has + access to the service's execution key.
+Unless specified otherwise, all services are created + as private by default.
+If first placeholder and second placeholder have the same size, the second one + is merged with first one and original placeholder element will become invalid. + If connection fails, the placeholders cannot be physically connected.
The purpose of this string is to describe the external server + in more details than just a short name alone could do. + The intended use is to show the string to the end user in UI + when UI is appropriate for the corresponding external service.
+Beside the requirement for it to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework. + However, the external service may have some specific rules in place for its servers.
+Although a server is uniquely identified by its Id, + the Name can identify it to the end user in UI when UI + is appropriate for the corresponding external service.
+Beside the requirement for the name to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework. + However, the external service may have some specific rules in place for its servers.
+The purpose of this string is to describe the external server + in more details than just a short name alone could do. + The intended use is to show the string to the end user in UI + when UI is appropriate for the corresponding external service.
+Beside the requirement for it to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework. + However, the external service may have some specific rules in place for its servers.
+Although a server is uniquely identified by its Id, + the Name can identify it to the end user in UI when UI + is appropriate for the corresponding external service.
+Beside the requirement for the name to be a non-empty string, + there are no other general restrictions imposed by the External Services Framework. + However, the external service may have some specific rules in place for its servers.
+The settings correspond to the checkboxes in the Synchronize with Central dialog + in the section "After synchronizing, relinquish the following worksets and elements:".
+An element can be owned (reflected in the "Edited By" parameter) either + by being checked out ("borrowed") or by belonging to a checked out workset.
+Relinquishing a workset will relinquish all its unmodified elements that the current user owns.
+The subtle interactions between checking out elements and checking out worksets + are beyond the scope of the documentation for this class. But as an example, + if a wall is borrowed (explicitly checked out) and then its workset is checked out, + then the wall is no longer considered borrowed because the workset ownership + implicitly grants ownership of all elements in the workset (except elements borrowed by other users).
+If there is no element corresponding to the given id, + then all the strings returned in WorksharingTooltipInfo are empty.
+ The return value may not be dependable in the middle of a transaction.
+ See the remarks on
Elements and worksets owned by other users are ignored.
+Only unmodified elements already in central will be relinquished by this method. + Newly added and modified elements cannot be relinquished + until they have been synchronized with central.
+For best performance, relinquish items in one big call, rather than many small calls.
+For best performance, check out all worksets in one big call, rather than many small calls.
+When there comes a contention error when locking the central model, this API would wait and retry + endlessly until getting the lock of the central model.
+For best performance, checkout all elements in one big call, rather than many small calls.
+Revit may check out additional elements that are needed to check out the elements you requested. + For example, if you request an element that is in a group, Revit will check out the entire group.
+For best performance, checkout all elements in one big call, rather than many small calls.
+Revit may check out additional elements that are needed to check out the elements you requested. + For example, if you request an element that is in a group, Revit will check out the entire group.
+When there comes a contention error when locking the central model, this API would wait and retry + endlessly until getting the lock of the central model.
+ This method returns a locally cached value which may not be up to date with the current state
+ of the element in the central. Because of this, the return value is suitable for reporting to an
+ interactive user (e.g. via a mechanism similar to Worksharing display mode), but cannot be considered
+ a reliable indication of whether the element can be immediately edited by the application. Also, the return value
+ may not be dependable in the middle of a local transaction. See the remarks
+ on
For performance reasons, the model is not validated to be workshared, + and the element id is also not validated; the element will not be expanded.
+ This method returns a locally cached value which may not be up to date with the current state
+ of the element in the central. Because of this, the return value is suitable for reporting to an
+ interactive user (e.g. via a mechanism similar to Worksharing display mode), but cannot be considered
+ a reliable indication of whether the element can be immediately edited by the application. Also, the return value
+ may not be dependable in the middle of a local transaction. See the remarks
+ on
For performance reasons, the model is not validated to be workshared, + and the element id is also not validated; the element will not be expanded.
+ This method returns a locally cached value which may not be up to date with the current state
+ of the element in the central. Because of this, the return value is suitable for reporting to an
+ interactive user (e.g. via a mechanism similar to Worksharing display mode), but cannot be considered
+ a reliable indication of whether the element can be immediately edited by the application. Also, the return value
+ may not be dependable in the middle of a local transaction. See the remarks
+ on
For performance reasons, the model is not validated to be workshared, + and the element id is also not validated; the element will not be expanded.
+ Return values from inquiries about the worksharing status of elements or worksets
+ rely on local caching of information from the central model so it is possible that the
+ information is out of date. Because of this, the return value is suitable for reporting to an
+ interactive user (e.g. via a mechanism similar to Worksharing display mode), but cannot be considered
+ a reliable indication of whether the element can be immediately edited by the application. To make an immediate
+ attempt to edit elements, use
In addition, information about the current user may not be + reliable while Revit is in the middle of an editing transaction. For example, + if you move an unowned wall from an unowned workset to a workset you own, + then before you explicitly or Revit automatically checks out the wall for you, + GetCheckoutStatus() might erroneously tell you CheckoutStatus.OwnedByCurrentUser + because although the official (as seen in central and by other users) owner is no one, + locally it looks like you already own it since it belongs to a workset you own.
+For operations that interact with central (as opposed to use only cached values), + Revit might opportunistically refresh some editing permissions or check the status of editing requests.
+ Some useful definitions to keep in mind follow:
+
Note that this status only indicates that the element has user changes in the central model. + A user change is typically an action specifically taken by a user. Making a user change + to an element requires that the user making the change reload all other user changes made to + the element in the central model. Making a user change also causes the element to be + checked out to the current user so other users will not be able to make user changes to + the same element.
+Elements can also be modified by system changes. A system change is one which is done + automatically by Revit to fully update the model after a user change occurs. Users may + make changes to an element in their local model even if the element contains additional + system changes in the central model.
+Example: Suppose Alice and Bob are working on the same model. Alice moves a wall which + contains windows. Then Alice synchronizes with the central file. The wall was explicitly + changed by Alice and so it will report as "UpdatedInCentral" in Bob's model. Bob + would have to reload latest before he could make user changes to that wall. In contrast, Revit + automatically moved the windows with the wall, so the windows do not contain any user changes. + The windows would therefore report "CurrentWithCentral" and Bob would be allowed to + modify them in his local model without reloading latest.
+Once an instance of this class is created, it can be further modified + by calling any of the other methods in any order. It is a specification of a setting for model open; + the methods of this class just adjust the specification, and do not themselves open or close worksets.
+Only user-created worksets can be specified to be opened or closed. All system worksets are automatically open. + An open workset allows its elements can be expanded and displayed. + For a closed workset, Revit tries to not expand its elements, and to that end, does not display them. + This is intended to help with performance by reducing Revit's memory footprint.
+All images in the schedule will be restored to their original sizes when viewed as a ScheduleSheetInstance on a ViewSheet.
+ This reverts any changes made by setting
In the schedule view the column widths will be adjusted to match the image sizes, but only the name of the image will be shown. + For example, the users can attach different images to the kinds of rebar instances. These images may have different sizes. + When the users create the rebar schedule with this image field, by default the column width of this image field is equal to other fields, + which means it is not associated with the image original sizes during the schedule creation.
+If there is at least one image field in the schedule, then setting this property will force all rows containing images to be + resized to the indicated height value (when viewed as a ScheduleSheetInstance on a ViewSheet). Setting this property will have + no effect if HasImageField returns false.
+This height will be maintained until the user or application restores the original image sizes (in API:
The additional project revision ids setting corresponds to the sheet's Revisions On Sheet parameter.
If provided, Revit will use this object to store any + errors or warnings that were encountered. Note that if the KeyBasedTreeEntries in the model are + already up to date, no errors or warnings will be added to this object.
+ This argument may be
If provided, Revit will use this object to store any + errors or warnings that were encountered.
+ This argument may be
This enum is provided so that an external resource server can + decide how much feedback it wishes to provide to the user.
+For example, Revit automatically loads all resources on file open. + This may cause many external resources to load at once. The server + may wish to provide truncated error messages.
+Reload() and LoadFrom() operations from the API are considered to + be LoadOperationType.Explicit.
+This method will return the line even if it isn't included.
+This property is not applicable to all dimensions. + For example, it is not available for spot slope dimensions, multi-segments dimensions, + dimensions using equality formula, and when dimension style is ordinate.
+If the position is not applicable, this property throws InvalidOperationException.
+This property is not applicable to all dimensions. + For example, it is not available for spot slope dimensions, multi-segments dimensions, + dimensions using equality formula, and when dimension style is ordinate.
+If the position is not applicable, this property throws InvalidOperationException.
+Notes for SpotDimension: +
If the curve loop contains curves such as elliptical segments or splines, it is possible the offset creation will fail if + Revit will not be able to trim contiguous curves to meet one another. If the offset is successful, offsets of those curve types + will be created as HermiteSplines.
If the curve loop contains curves such as elliptical segments or splines, it is possible the offset creation will fail if + Revit will not be able to trim contiguous curves to meet one another. If the offset is successful, offsets of those curve types + will be created as HermiteSplines.
If the curve loop contains curves such as elliptical segments or splines, it is possible the offset creation will fail if + Revit will not be able to trim contiguous curves to meet one another. If the offset is successful, offsets of those curve types + will be created as HermiteSplines.
Note that for input elliptical fragments and NurbSpline curves, any offsets will be created as HermiteSplines.
Moves this link instance so that the internal origin + of the linked document is aligned to the internal origin + of the host document. This is a one-time movement and does not + set up any shared coordinates relationship.
+If the rotation angle of the link instance was changed after insertion, + the rotation angle can be preserved or reset to the original insertion angle.
+Sets to true if:
+Sets to false to retain the current angle of the link instance after it is moved + if there was a rotation \ mirror transform on the link instance.
+ +Moves this link instance so that the base point in + the linked document is aligned to the base point in the + host document. This is a one-time movement and does not + set up any shared coordinates relationship.
+If the rotation angle of this link instance was changed after insertion, + the rotation angle can be preserved or reset to the original insertion angle.
+Sets to true if:
+Sets to false to retain the current angle of the link instance after it is moved + if there was a rotation \ mirror transform on the link instance.
+ +If the curve is marked as read-only (because it was extracted directly from +a Revit element or collection/aggregation object), calling this method +causes the object to be changed to carry a disconnected copy of the original curve. The +modification will not affect the original curve or the object that supplied it.
+Many methods in the Revit API will not use the graphics style associated to this curve. For +example, curves used as portions of the sketch of an element will not read this property. +Newly created curve elements +will not use this value either, as they inherit their graphical properties from their associated category.
+For Line, HermiteSpline, NurbSpline and Cylindrical Helix, the right direction + is along the cross product of the tangent at that point and the reference vector. + In other words, the "right" side of the curve at a given point on the curve is defined with the reference vector + being thought of as the upward direction and curve tangent being thought of as the forward direction, + as if you are walking along the curve with your body aligned to the reference vector.
For Arc and Ellipse, the right direction is defined relative to the axis of the arc or ellipse + in conjunction with the reference vector. If the dot product of the reference vector with the axis is positive, + then the right direction is along the cross product of the curve tangent the axis. + If the dot product is negetive, then it is in the other way. + If the dot product is zero, then it is an input error.
+ + More details of the behavior depending on the type of curve: +Using instance geometry means that FamilyInstance has its own geometry that may be different from family. This takes more memory but can be used e.g. to assign instance specific materials to the instance faces.
+For a family instance which connects two rooms or spaces, such as a door or window, the points determine which room or space is considered the "from" and which is considered the "to".
+See
See
The points determine which room or space is considered the "from" and which is considered the "to" for a family instance which connects two rooms or spaces, such as a door or window.
+This method returns the original geometry of the instance. The instance's geometry +will reflect the values of all instance level parameters (e.g. reference levels for columns) and +of the placement conditions (so a beam placed along a 20' long line will be 20' long). It excludes +all modifications made to the geometry due to operations like joining, cutting, openings, coping, +or extensions.
+The geometry will not include the GeometryInstance typically returned when you access the geometry +of a FamilyInstance via Element.Geometry. But GeometryInstances may be encountered if there +are nested family instances within the family.
+The geometry is returned in the coordinates of the FamilySymbol, not the coordinates of the +instance. If needed, you can transform the returned GeometryElement using the GetTransformed() +method, passing the results from GetTransform(), or some other user-defined transformation. +
+The geometry returned is from Revit's internal computations and does not represent actual +Revit geometry. Thus, you cannot use it as a reference for other geometry.
+Splitting is permitted for architectural and structural columns, beams and braces. Beams and braces that are not a line or an arc is not permitted. See
Splitting modifies this family instance and adds a second family instance to the model.
+The default orientation of adaptive points is AdaptivePointOrientationType.ToInstance.
+All the items of this enumerated type were renamed for Revit 2016 + to better align the names with the corresponding text in the Revit UI. + The numeric values of the items weren't modified, allowing existing + applications to work. However, to be able to rebuild an application, + all point orientations need to be changed to their respective new names.
+The adaptive point will be oriented to the coordinate system of the adaptive + family instance the point is part of. This is the default orientation of adaptive points.
+This option was previously named: FamilyOrthogonal
+The Z axis of the adaptive point will be oriented to the Z axis of the adaptive family instance + the point is part of. The XY axis are determined by the XY of the geometry the point is hosted on.
+This option was previously named: FamilyVertical
+The adaptive point will be oriented to the coordinate system of the document the instance is placed in.
+This option was previously named: PlacementOrthogonal
+The Z axis of the adaptive point will be oriented to the Z axis of the document the instance + is placed in. The XY axis are determined by the XY of the geometry the point is hosted on.
+This option was previously named: PlacementVertical.
+The adaptive point will be oriented to the coordinate system of the geometry the point is hosted on. + However, the orientation of the Z axis is controlled by the order of placed points. If the placed + adaptive points of a component are placed in a different order with respect to the host order, + (clockwise instead of counter-clockwise), then the Z axis will invert and the planar projection will flip.
+This option was previously named: HostReferenceAutoFlip.
+The adaptive point will be oriented to the coordinate system of the geometry the point is hosted on. + This option was previously named: HostReferenceStrictly
+The parameter must be parameterizable, meaning it cannot be read-only, + driven by a formula, or have any other restrictions imposed by Revit.
+The parameter's value type must match the type of the global parameter.
+Once associated property can be later dissociated by calling the
+
BoundingBoxXYZ objects are used in Revit in several places related to views (for example, the section box of a +3D view or the definition of a section or detail view). BoundingBoxXYZ objects can also be obtained from elements representing the +boundary of the element in a given view.
+The extents of the box are determined by three orthogonal planes extended through the minimum (
This class also has the ability to detect and mark certain extents as disabled. Note that in the current Revit API uses +of this class it is not expected that Revit will give objects with disabled extents, and disabled extents in objects +sent to Revit will likely be ignored.
+Note: the bounding box may not be empty even if Element::Geometry::get returns nothing. This can happen if the +element contains no 3D model geometry since by default, Element::Geometry::get only returns 3D model geometry while +GeometryElement::GetBoundingBox also takes 2D plan-view geometry and elevation-view geometry into account.
+This property is not applicable to all dimensions. +For example, it is not available for spot dimensions, +dimensions using equality formula, and when dimension style is ordinate.
+If the position is not applicable, this property returns NULL +and will not allow setting a value.
+This property is not applicable to all dimensions. +For example, it is not available for spot dimensions, +dimensions using equality formula, and when dimension style is ordinate.
+If the position is not applicable, this property returns NULL +and will not allow setting a value.
+This event is raised when failures are being processed during transaction commit or rollback operations. + Handlers of this event have a limited ability to modify the document and/or failures in it, using the provided + restricted failures accessor interface.
+The event arguments provide access to the FailuresAccessor via
+
The arguments also allow you to set a processing result via
+
For synchronizing with central operation, there are 4 steps.
+ 1) Save to local (before save to central) - Serializes the streams from memory to local disk cache;
+
For document open operation, just download the model from server and then open it;
It is NOT recommended to deal with time-consuming work when handling WorksharedOperationProgressChanged event, otherwise it would increase synchronizing with central or model open time.
+If this value is not explicitly set, the default value (Continue) will be used. If the event callback
+ is resolving errors explicitly, it must be set to ProceedWithCommit - see the remarks for the
+
Note that ProceedWithCommit should not be set if the handler has not resolved any errors - the + handler will be called again as a result of the commit request and Revit failure handling will + never be reached.
+Setting this result may not affect the outcome if other observers of the event are invoked after this one. + The most prohibitive result set by all handlers will be used.
+The event arguments provide access to the FailuresAccessor via
The arguments also allow you to set a processing result
+ via
The host project's True North and shared origin are recorded in the linked project, based on the current position of the linked instance. + This location is now named in both the host project and the linked project. More than one position of the link can be recorded.
+When you publish shared coordinates from a host Revit project to a linked DWG, this changes the linked DWG. The origin of the host Revit + project's shared coordinate system becomes the origin of a new User Coordinate System (UCS) in the DWG file. The Y axis of the new UCS corresponds + to the host project's True North. You can name the UCS when you publish coordinates. It is not recommended that you change this name after + publishing coordinates.
+Note: Currently, only
When you acquire coordinates from the linked model, the shared coordinates of the linked model become the + shared coordinates of the host model, based on the position of the linked model instance in the host model. + There is no change to the host model's internal coordinates.
+The host model also acquires True North from the linked model. The origin of the linked model's shared + coordinates becomes the origin of the host model's shared coordinates.
+When a Revit model acquires coordinates from a linked DWG file, the World Coordinate System (WCS) of the + selected linked DWG file becomes the shared coordinate system of the host Revit model, based on the position + of the linked DWG instance. The Y axis of the DWG becomes True North, and the origin of the DWG becomes the + origin of the shared coordinate system of the Revit model.
+On acquiring coordinates from a geo-referenced model, the geolocation information will be pulled from the linked + model to the host model.
+Unlike UI operation Acquire Coordinates, calling the API would always overwrite the geolocation information in the + host model even if it is different from the one in the linked model, or the linked model has empty geolocation information + (in which case the geolocation information in the host model would be removed).
+If central is locked but Revit can determine that + the model in the current session is out of date + without opening central, this method will return false + instead of throwing CentralModelContentionException.
This method may not be called unless all transactions, sub-transactions, and transaction groups + that were opened by the API code were closed. + That also implies that this method cannot be called during dynamic updates. + Event handlers are not allowed to save document that are currently in modifiable state.
+If options.rename is true, then the document's title in Revit's title bar + will be updated automatically to reflect the file's new name.
+This method may not be called unless all transactions, sub-transactions, and transaction groups + that were opened by the API code were closed. + That also implies that this method cannot be called during dynamic updates. + Event handlers are not allowed to save document that are currently in modifiable state.
+If options.rename is true, then the document's title in Revit's title bar + will be updated automatically to reflect the file's new name.
+If the document was created in this current session and has not been saved to a file yet, + it needs to be first saved using the SaveAs method instead.
+This method may not be called unless all transactions, sub-transactions, and transaction groups + that were opened by the API code were closed. + That also implies that this method cannot be called during dynamic updates. + Event handlers are not allowed to save document that are currently in modifiable state.
+If the document was created in this current session and has not been saved to a file yet, + it needs to be first saved using the SaveAs method instead.
+This method may not be called unless all transactions, sub-transactions, and transaction groups + that were opened by the API code were closed. + That also implies that this method cannot be called during dynamic updates. + Event handlers are not allowed to save document that are currently in modifiable state.
+Loading an entire family may take a considerable amount of time and memory. It is +recommended that you use one of the LoadFamilySymbol() methods +and only load those symbols that you need.
+Loading an entire family may take a considerable amount of time and memory. It is +recommended that you use one of the LoadFamilySymbol() methods +and only load those symbols that you need.
+Loading an entire family may take a considerable amount of time and memory. It is +recommended that you use one of the LoadFamilySymbol() methods +and only load those symbols that you need.
+The phases are returned in order from earliest phase to latest phase.
+When Revit is running with UI activated, the default created phase for newly created elements is inherited from the phase of the currently active view.
+When Revit is running without its UI, such as when Revit runs on Autodesk Forge Design Automation API for Revit, +the default phase for newly created elements is the latest phase in the document.
+The values are Element Ids of all family types that match
+ the category specified by the definition of the given parameter.
+ The elements are either of class
If there are no applicable types of such category the returned + collection will be empty.
+A family is parametric if it contains parameter-driven relations between + its elements, such as labeled dimensions or locked tangential joins.
+Parametric families containing large sketches may cause performance
+ problems. Caution is therefore advised before adding any constraints to
+ a yet non-parametric family that already contains large sketches.
+ See
The input scheme id could be InvalidElementId to clear the scheme for the specified category.
+Some examples of returnning false:
+There could be at most three
Notes:
+Model space is the global 3D coordinate space in which the geometry + of the model lives.
+View projection space is the 3D Euclidean space with a coordinate system such that + X and Y are horizontal and vertical directions in the view projection plane and Z + is the cross product of X and Y. Distances in the projection space are the same as + would be measured on paper if the view is printed without additional scaling.
+ Most views will return just one
When the view's crop region is split, many TransformWithBoundary objects will be returned.
+ Each TransformWithBoundary corresponds to one region of the split crop. To determine which
+ TransformWithBoundary to use when converting a model point into view projection space,
+ first test to see which split crop region boundary contains the model point.
+ See
The parent transaction (or a parent sub-transaction, if any) + can still be committed, but the changes rolled back by this + method will not be part of the committed transaction.
+RollBack can be called only when all inner sub-transaction, if any, are finished, + i.e. they were either committed or rolled back. If there is still a sub-transaction open, + an attempt to roll this outer sub-transaction back will cause an exception.
+The changes are not permanently committed to the document yet. They will be + committed only when the active transaction is committed. If the transaction + is rolled back instead, the changes committed during this sub-transaction will be discarded.
+Commit can be called only when all inner sub-transactions, if any, are already finished, + i.e. they were either committed or rolled back. If there is still a sub-transaction open, + an attempt to commit this outer sub-transaction will cause an exception.
+A sub-transaction can only be started in an open transaction, + and it must be closed (committed or rolled back) while still inside the open transaction.
+A sub-transaction can be started in another open sub-transaction, + but then it must be closed before the parent sub-transaction is closed.
+If a sub-transaction was started and not committed or rolled back by the time
+ the SubTransaction object is about to be disposed, the destructor will roll back the
+ sub-transaction automatically, thus all changes made to the document during the
+ sub-transaction will be discarded. It is not recommended to rely on this default
+ behavior though. Instead, it is advised to always call either
Use this change type to trigger an Updater when elements change in any way. + For maximum efficiency, we recommend the use of ChangeTypeParameter and + ChangeTypeGeometry, if applicable, instead.
+Caution: Changes to an element by an Updater using this trigger will result + in re-triggering of the Updater. For example, Updater1 triggers on + ChangeTypeAny on Element X. A Revit user modifies parameter A of X. + Updater1 is triggered and modifies X's parameter B. The change in parameter B, + triggers another call to Updater1.Execute(). If Updater1 continues to + modify X, it can run into an infinite loop. Infinite loops are detected by + Revit and result in the Updater being disabled.
+Note: This change type will not trigger on newly created or deleted elements or on changes caused by Undo and Redo.
+The elements that this method will return:
+
After setting the property CreatedPhaseId, regeneration can fail if CreatedPhaseId and DemolishedPhaseId
+ are out of order with respect to their index in the property
When Revit is running with UI activated, the default created phase for newly created elements is inherited from the phase of the currently active view.
+When Revit is running without its UI, such as when Revit runs on Autodesk Forge Design Automation API for Revit,
+ the default CreatedPhaseId for newly created elements is the latest phase in
Transient elements are usually created for short term use. This type of element can be created via Document.MakeTransientElements().
+Transient and Permanent elements are not allowed to reference each other. A transient element can only refer to other transient elements in the same document.
+Transient elements also cannot be selected or scheduled, and will not be saved when the document is saved, and will be discarded when the document is closed.
+Modifying a transient element does not require a transaction, because such elements are not part of the model. As an effect of this, however, creation and modification of transients cannot be undone.
+Because transient elements are technically not part of the model, they will not be found when using standard element filters, or in any collection of elements Revit returns, such as elements reported in dynamic updaters, etc.
+Multiple matches of parameters with the same name can occur because shared parameters or project parameters can be bound to an element category even if there is a built-in parameter with the same name already.
If this method is used to find built-in parameters the code will not be portable to other languages of Revit (because built-in parameter names are translated, and this method matches the translation).
For the reasons above this method should be used sparingly and only when you have a reasonable expectation that only one parameter exists with the given name, and when portability across multiple languages is not a requirement.
Safer approaches include:
Multiple matches of parameters with the same name can occur because shared parameters or project parameters can be bound to an element category even if there is a built-in parameter with the same name already.
+If this method is used to find built-in parameters the code will not be portable to other languages of Revit (because built-in parameter names are translated, and this method matches the translation).
+For the reasons above this method should be used sparingly and when portability across multiple languages is not a requirement.
+Safer approaches include:
+The collection consists of only visible parameters associated to the element; it returns a different list than Element.Parameters.
+The parameters are returned in the order in which they appear in the Revit UI within a given group; +however, parameters of different groups may be mixed within this output.
+Currently the Revit UI order is determined first by group and next by the order of the individual parameters.
+This call will retrieve 3d representation of the element.
Geometry objects provided from this method are obtained directly from the element. When +the element is changed for any reason, the geometry will be recalculated by Revit and geometry +objects obtained before the change are likely to no longer be valid. If you need to preserve +geometry information obtained an element even after changes to that element, you should copy +the geometry objects or save the properties independently.
+Although the geometry obtained from this method comes directly from the element, any attempt to modify +any of the geometry objects will operate only on a disconnected copy of the original geometry object from the element. +The modification will not affect the geometry of the original element from which it was obtained - +to change the geometry of the element you must use methods that directly affect the geometry calculated or +stored by Revit for this element.
+If you require that the geometry items obtained contain valid
+
This event is raised when failures are being processed during transaction commit or rollback operations. + Handlers of this event have a limited ability to modify the document and/or failures in it, using the provided + restricted failures accessor interface.
+The event arguments provide access to the FailuresAccessor via
+
The arguments also allow you to set a processing result via
+
Selection.SetElementIds(Selection.GetElementIds());Note that to improve usability, the behavior of this option has some added intelligence
+ beyond simply checking whether the element is pinned. For example, if a model group is pinned,
+ the corresponding attached detail group is not selectable if selection of pinned elements is
+ disabled. To check whether a particular element is pinned for purposes of this setting, see
+
These settings are per user and will affect the selection behavior in all + projects and families. The settings are not stored in the project.
If all links succeeded in loading, the function does + nothing. If any links failed to load, this function + will display the Unresolved References dialog, giving + the user the option to open the Manage Links dialog + to correct any problems.
+To ensure the dialog fits on the screen, Revit will + only list up to ten link names. Additional links will + be mentioned as, "And >number< additional links." This + is the same behavior Revit's user interface uses.
+A map from the display name of a link to the LinkLoadResult + for that link.
+ +This method will be called automatically by Revit after the external resource load process is complete.
+Note that automatic loads can occur in the context of other operations such as opening a file. + During automatic loads, it is therefore recommended that the server only display UI that is critical + for the user to see (such as error message).
+The loading operation type is Explicit when the user is specifically trying to reload the resource. + During explicit loads, it may be desirable to provide more feedback to the user, such as specific feedback + that the load operation succeeded.
+The loading operation type can be accessed through
Note that providing messages and other UI feedback for Revit links is more complicated, + because links can be nested. The UI server may wish to provide different messages and take + different actions, depending on whether a link loaded from the DB server was a "top-level" link, + or was nested. For example, while it may be possible to correct an error that occurred with a + top-level link by loading it directly, this cannot be done with a nested link, as Revit will throw + an exception.
+To complicate things further, the same Revit document may appear more than once in a tree of nested + links, and the UI server should avoid repeatedly posting the same message for instances of that + document.
+To help UI servers handle situations where a nested tree of links is loaded: +
The ExternalResourceLoadData contains a property, ErrorsReported, which the server can + use to indicate whether it handled any errors for the resource.
For Revit links specifically, Revit will check this value to see + if it should report errors about a given link in the Unresolved + References dialog. An IExternalResourceUIServer can set this value + to true to avoid redundant messages.
Note that it is possible for Revit to encounter errors internally + even if the server successfully provides a reference. In general, this + value should only be set to true if the server has reported an + error condition.
+This method will be called automatically by Revit after the external resource load process is complete.
+Note that automatic loads can occur in the context of other operations such as opening a file. + During automatic loads, it is therefore recommended that the server only display UI that is critical + for the user to see (such as error message).
+The loading operation type is Explicit when the user is specifically trying to reload the resource. + During explicit loads, it may be desirable to provide more feedback to the user, such as specific feedback + that the load operation succeeded.
+The loading operation type can be accessed through
Note that providing messages and other UI feedback for Revit links is more complicated, + because links can be nested. The UI server may wish to provide different messages and take + different actions, depending on whether a link loaded from the DB server was a "top-level" link, + or was nested. For example, while it may be possible to correct an error that occurred with a + top-level link by loading it directly, this cannot be done with a nested link, as Revit will throw + an exception.
+To complicate things further, the same Revit document may appear more than once in a tree of nested + links, and the UI server should avoid repeatedly posting the same message for instances of that + document.
+To help UI servers handle situations where a nested tree of links is loaded: +
The ExternalResourceLoadData contains a property, ErrorsReported, which the server can + use to indicate whether it handled any errors for the resource.
For Revit links specifically, Revit will check this value to see + if it should report errors about a given link in the Unresolved + References dialog. An IExternalResourceUIServer can set this value + to true to avoid redundant messages.
Note that it is possible for Revit to encounter errors internally + even if the server successfully provides a reference. In general, this + value should only be set to true if the server has reported an + error condition.
+IExternalResourceUIServer is the UI server associated with IExternalResourceServer. + IExternalResourceServer provides an interface for loading an external resource (such as a Revit + link or the keynote data) from a source outside of Revit. IExternalResourceUIServer provides + an interface for displaying the results of such an operation to the Revit user.
+IExternalResourceUIServers must be associated with an IExternalResourceServer in order
+ to display any UI. Implement
The primary method in IExternalResourceUIServer is
The ExternalResourceLoadData passed to HandleLoadResourceResults will also contain a GUID + to uniquely identify the load request. This identifier can help IExternalResourceUIServers + query their IExternalResourceServers for additional information about errors that occurred + during specific load operations. Particularly, the IExternalResourceUIServer may wish to + ask the IExternalResourceServer about errors which Revit is not aware of. For example, + if the IExternalResourceServer includes a website and the user is not logged in, Revit + will not have any information about this error.
+If an existing FilterElement id was set during construction of the object or through the FilterToSelect property, + that FilterElement will be selected for editing.
+If a new filter name was set during construction of the object or through the NewFilterName property, + a new ParameterFilterElement will be created and that new element will be selected for editing. + If this option was chosen, the id of the explicitly create new filter will be stored in the NewFilterId property.
+Note that the user may opt to add, delete or edit any of the available filter elements (or make no changes at all). + To monitor which filters have been changed, use other Revit API mechanisms such as Dynamic Update or the DocumentChanged event.
+This would typically be a name derived by the application that matches the purpose of the save operation + it intends to do. The user is permitted to alter the initial file name.
+If the extension is not included, the file would be given the selected file extension + for the active filter (when saved). If the extension is included, it will be ignored if the extension does + not match one of the possible filter extensions. When not set, the file name entry field in the dialog will + be blank and the user will have to enter a file name.
+The behavior and appearance of this dialog matches the Revit "Save as" dialog. This is a general-purpose dialog + for saving any given file type, and the Options shown in the dialog for Revit projects and families will not be + shown. To prompt the user to save the active Revit document specifically, use UIDocument.SaveAs(UISaveAsOptions) instead.
+The user will be requested to select or enter a file name matching the corresponding filter. + If an existing file is selected, there will be + a default prompt about overwriting the file shown, where the user can confirm or cancel this file selection.
+The folder location shown when the dialog is displayed defaults to the most recently used file location + for saving or exporting.
+Use of this dialog does not actually save an existing file, but it will provide the selected file path + back to the caller to take any action necessary.
+The behavior and appearance of this dialog matches the Revit "Open" dialog. This is a general-purpose dialog + for opening any given file type, and options to configure settings like worksharing options will not be included.
+The user will be prompted to select an existing file that matches one of the provided filters. The user may not + enter a file name that does not exist.
+The folder location shown when the dialog is displayed defaults to the most recently used file location + for opening or importing.
+Use of this dialog does not actually open an existing file, but it will provide the selected file path + back to the caller to take any action necessary.
+This method loads the add-ins listed in the provided add-in manifest file. +The API will look for the file in the dedicated folders supported by Revit for loading add-in manifest files.
+Some add-ins may have settings in which they decline the ability for Revit to load the external application declared +in the .addin in mid-session. +This happens when the AllowLoadingIntoExistingSession tag is set to "No" in the add-in manifest file, and if the tag +isn't present, the default is set to "Yes".
+ Note that when Revit starts an add-in in the middle of the session, some add-in logic may not function as expected
+because of the different interactions with the session. Specifically:
+
Also, some add-ins may not be able to fully initialize when loading in the middle of the session. This is because some
+activities must take place at the start of the Revit session:
+
This method opens its own transaction, so it's not permitted to be invoked in an active transaction. + In a single invocation, the user can place only one view onto the active sheet.
+The user is not permitted to change the active sheet view or the view to be placed + during this placement operation (the operation will be cancelled).
+The user can cancel the placement operation by pressing Cancel or ESC or a click elsewhere in the UI.
+ This method can't be used to place a schedule on a sheet.
+ Use
If true, the viewport representing this view will be replaced by the new viewport created during placement. + If the view is allowed only to be on one sheet, this will remove the viewport from the old sheet. + If the view is allowed to be on multiple sheets, and the view is currently placed on the active sheet, + the old viewport on this sheet will be replaced.
+ If false, if the view is only allowed to be on one sheet, + or if the view is allowed to be on multiple sheets but is already on the active sheet, an exception will be thrown. + +This method opens its own transaction, so it's not permitted to be invoked in an active transaction. +In a single invocation, the user can place multiple instances of the input family type until they finish the +placement (with Cancel or ESC or a click elsewhere in the UI). The user will not be permitted to change the type to be placed. +Users are not permitted to change the active view during this placement operation (the operation will be completed). +
+This method differs from
This method opens its own transaction, so it's not permitted to be invoked in an active transaction. +In a single invocation, the user can place multiple instances of the input family type until they finish the +placement (with Cancel or ESC or a click elsewhere in the UI). The user will not be permitted to change the type to be placed. +Users are not permitted to change the active view during this placement operation (the operation will be completed). +
+This method differs from
This class represents a document opened in the user interface and therefore offers interfaces + to work with settings and operations in the UI (for example, the active selection). Revit can have multiple + projects open and multiple views to those projects. The active or top most view will be the + active project and hence the active document which is available from the UIApplication object.
+ Obtain the database level Document (which contains interfaces not related to the UI) via the + Document property. If you have a database level Document and need to access it from the UI, you can + construct a new UIDocument from that object (the document must be open and visible in the UI to allow the methods to + work successfully). +This method loads the add-ins listed in the provided add-in manifest file. +The API will look for the file in the dedicated folders supported by Revit for loading add-in manifest files.
+Some add-ins may have settings in which they decline the ability for Revit to load the external application declared +in the .addin in mid-session. +This happens when the AllowLoadingIntoExistingSession tag is set to "No" in the add-in manifest file, and if the tag +isn't present, the default is set to "Yes".
+ Note that when Revit starts an add-in in the middle of the session, some add-in logic may not function as expected
+because of the different interactions with the session. Specifically:
+
Also, some add-ins may not be able to fully initialize when loading in the middle of the session. This is because some
+activities must take place at the start of the Revit session:
+
This method loads the add-ins listed in the provided add-in manifest file. +The API will look for the file in the dedicated folders supported by Revit for loading add-in manifest files.
+Some add-ins may have settings in which they decline the ability for Revit to load the external application declared +in the .addin in mid-session. +This happens when the AllowLoadingIntoExistingSession tag is set to "No" in the add-in manifest file, and if the tag +isn't present, the default is set to "Yes".
+ Note that when Revit starts an add-in in the middle of the session, some add-in logic may not function as expected
+because of the different interactions with the session. Specifically:
+
Also, some add-ins may not be able to fully initialize when loading in the middle of the session. This is because some
+activities must take place at the start of the Revit session:
+
This method opens its own transaction, so it's not permitted to be invoked in an active transaction. + In a single invocation, the user can place only one view onto the active sheet.
+The user is not permitted to change the active sheet view or the view to be placed + during this placement operation (the operation will be cancelled).
+The user can cancel the placement operation by pressing Cancel or ESC or a click elsewhere in the UI.
+ This method can't be used to place a schedule on a sheet.
+ Use
If true, the viewport representing this view will be replaced by the new viewport created during placement. + If the view is allowed only to be on one sheet, this will remove the viewport from the old sheet. + If the view is allowed to be on multiple sheets, and the view is currently placed on the active sheet, + the old viewport on this sheet will be replaced.
+ If false, if the view is only allowed to be on one sheet, + or if the view is allowed to be on multiple sheets but is already on the active sheet, an exception will be thrown. + +This method opens its own transaction, so it's not permitted to be invoked in an active transaction. +In a single invocation, the user can place multiple instances of the input family type until they finish the +placement (with Cancel or ESC or a click elsewhere in the UI). The user will not be permitted to change the type to be placed. +Users are not permitted to change the active view during this placement operation (the operation will be completed). +
+This method differs from
This method opens its own transaction, so it's not permitted to be invoked in an active transaction. +In a single invocation, the user can place multiple instances of the input family type until they finish the +placement (with Cancel or ESC or a click elsewhere in the UI). The user will not be permitted to change the type to be placed. +Users are not permitted to change the active view during this placement operation (the operation will be completed). +
+This method differs from