Sign in
2023 Members
Changes 4
M

SunAndShadowSettings

Name Return Type Description Inherited From
M ArePhasesModifiable() bool Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element .) Element
M CalculateTimeZone(Double, Double) double Use Revit's utilities to calculate the time zone for a given longitude and latitude.
M CanBeHidden(View) bool Indicates if the element can be hidden in the view. (Inherited from Element .) Element
M CanBeLocked() bool Identifies if the element can be locked. (Inherited from Element .) Element
M CanDeleteSubelement(Subelement) bool Checks if given subelement can be removed from the element. (Inherited from Element .) Element
M CanHaveTypeAssigned.() bool Identifies if the element can have a type assigned. (Inherited from Element .) Element
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element .) Element
M DeleteEntity(Schema) bool Deletes the existing entity created by %schema% in the element (Inherited from Element .) Element
M DeleteSubelement(Subelement) bool Removes a subelement from the element. (Inherited from Element .) Element
M DeleteSubelements(IList<Subelement>) bool Removes the subelements from the element. (Inherited from Element .) Element
M Dispose() None (Inherited from Element .) Element
M Equals None Determines whether the specified Object is equal to the current Object . (Inherited from Object .) Object .
M FitToModel() None Adjust SunAndShadowSettings to fit around the current model geometry.
M GetActiveSunAndShadowSettings(Document) Element Returns the current SunAndShadowSettings element assigned to the active view for the supplied document.
M GetDependentElements(ElementFilter) IList<ElementId> Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element .) Element
M GetEntity(Schema) The returned Entity. Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. (Inherited from Element .) Element
M GetEntitySchemaGuids() IList<Guid> Returns the Schema guids of any Entities stored in this element. (Inherited from Element .) Element
M GetExternalFileReference() ExternalFileReference Gets information pertaining to the external file referenced by the element. (Inherited from Element .) Element
M GetExternalResourceReference(ExternalResourceType) ExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element .) Element
M GetExternalResourceReferenceExpanded(ExternalResourceType) IList<ExternalResourceReference> Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element .) Element
M GetExternalResourceReferences() IDictionary Gets the map of the external resource references referenced by the element. (Inherited from Element .) Element
M GetExternalResourceReferencesExpanded() IDictionary Gets the expanded map of the external resource references referenced by the element. (Inherited from Element .) Element
M GetFrameAltitude(Double) double Identifies the altitude of the sun (angle in radians) for a specific frame.
M GetFrameAzimuth(Double) double Identifies the azimuth of the sun (angle in radians) for a specific frame.
M GetFrameTime(Double) DateTime Identifies the date and time of the SunAndShadowSettings element for a given frame.
M GetGeneratingElementIds(GeometryObject) ICollection<ElementId> Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element .) Element
M GetGeometryObjectFromReference(Reference) GeometryObject Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element .) Element
M GetHashCode None Serves as a hash function for a particular type. (Inherited from Object .) Object .
M GetMatchingPreset() string Finds the name of the 'per-document' SunAndShadowSettings that matches the properties of this per-view element.
M GetMaterialArea(ElementId, Boolean) double Gets the area of the material with the given id. (Inherited from Element .) Element
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. (Inherited from Element .) Element
M GetMaterialVolume(ElementId) double Gets the volume of the material with the given id. (Inherited from Element .) Element
M GetMonitoredLinkElementIds() IList<ElementId> Provides the link instance IDs when the element is monitoring. (Inherited from Element .) Element
M GetMonitoredLocalElementIds() IList<ElementId> Provides the local element IDs when the element is monitoring. (Inherited from Element .) Element
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. (Inherited from Element .) Element
M GetParameter(ForgeTypeId) Parameter Retrieves a parameter from the element given identifier. (Inherited from Element .) Element
M GetParameterFormatOptions(ElementId) FormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element .) Element
M GetParameters(String) IList<Parameter> Retrieves the parameters from the element via the given name. (Inherited from Element .) Element
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element .) Element
M GetSubelements() IList<Subelement> Returns the collection of element subelements. (Inherited from Element .) Element
M GetSunrise(DateTime) DateTime Identifies the sunrise time for the SunAndShadowSettings element at its current location and indicated date.
M GetSunset(DateTime) DateTime Identifies the sunset time for the SunAndShadowSettings element at its current location and indicated date.
M GetType None Gets the Type of the current instance. (Inherited from Object .) Object .
M GetTypeId() ElementId Returns the identifier of this element's type. (Inherited from Element .) Element
M GetValidTypes.() ICollection<ElementId> Obtains a set of types that are valid for this element. (Inherited from Element .) Element
M HasPhases() bool Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element .) Element
M IsAfterStartDateAndTime(DateTime) bool Checks whether the end date and time is valid.
M IsBeforeEndDateAndTime(DateTime) bool Checks whether the start date and time is valid.
M IsCreatedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsDemolishedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsExternalFileReference() bool Determines whether this Element represents an external file. (Inherited from Element .) Element
M IsFrameValid(Double) bool Checks whether the frame is valid for the supplied SunAndShadowSettings.
M IsGroundPlaneLevelValid(ElementId) bool Checks whether the element represents a valid Ground Plane level.
M IsHidden(View) bool Identifies if the element has been permanently hidden in the view. (Inherited from Element .) Element
M IsMonitoringLinkElement() bool Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element .) Element
M IsMonitoringLocalElement() bool Indicate whether an element is monitoring other local elements. (Inherited from Element .) Element
M IsPhaseCreatedValid(ElementId) bool Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element .) Element
M IsPhaseDemolishedValid(ElementId) bool Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element .) Element
M IsTimeIntervalValid(SunStudyTimeInterval) bool Checks whether the time interval is valid for the SunAndShadowType.
M IsValidType(ElementId) bool Checks if given type is valid for this element. (Inherited from Element .) Element
M LookupParameter(String) nullNothingnullptr Attempts to find a parameter on the element which has the given name. (Inherited from Element .) Element
M RefersToExternalResourceReference(ExternalResourceType) bool Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element .) Element
M RefersToExternalResourceReferences() bool Determines whether this Element uses external resources. (Inherited from Element .) Element
M SetEntity(Entity) None Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element .) Element
M ToString None Returns a string that represents the current object. (Inherited from Object .) Object .
Name Return Type Description Inherited From
P ActiveFrame double Identifies the active animation frame for a single-day or multi-day study, starting at 1.0 for the first frame and incrementing in intervals of 1.0.
P ActiveFrameTime DateTime Identifies the date and time of the SunAndShadowSettings element for the active frame.
P Altitude double Altitude setting (angle in radians). This is only relevant when dealing with a SunAndShadowSettings element that uses lighting mode.
P AssemblyInstanceId ElementId The id of the assembly instance to which the element belongs. (Inherited from Element .) Element
P Azimuth double Azimuth setting (angle in radians). This is only relevant when dealing with a SunAndShadowSettings element that uses lighting mode.
P BoundingBox BoundingBoxXYZ Retrieves a box that circumscribes all geometry of the element. (Inherited from Element .) Element
P Category Category Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element .) Element
P CreatedPhaseId ElementId Id of a Phase at which the Element was created. (Inherited from Element .) Element
P DemolishedPhaseId ElementId Id of a Phase at which the Element was demolished. (Inherited from Element .) Element
P DesignOption DesignOption Returns the design option to which the element belongs. (Inherited from Element .) Element
P Document Document Returns the Document in which the Element resides. (Inherited from Element .) Element
P EndDateAndTime DateTime Identifies the end date and time.
P Geometry GeometryElement Retrieves the geometric representation of the element. (Inherited from Element .) Element
P GroundPlaneHeight double Identifies the ground plane height.
P GroundPlaneLevelId ElementId Identifies the element id of the Ground Plane level for the SunAndShadowSettings element.
P GroupId ElementId The id of the group to which an element belongs. (Inherited from Element .) Element
P Id ElementId A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element .) Element
P IsModifiable bool Identifies if the element is modifiable. (Inherited from Element .) Element
P IsTransient bool Indicates whether an element is transient or permanent. (Inherited from Element .) Element
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element .) Element
P Latitude double Identifies the current latitude used by the SunAndShadowSettings element.
P LevelId ElementId The id of the level associated with the element. (Inherited from Element .) Element
P Location Location This property is used to find the physical location of an element within a project. (Inherited from Element .) Element
P Longitude double Identifies the current longitude used by the SunAndShadowSettings element.
P Name string A human readable name for the Element. (Inherited from Element .) Element
P NumberOfFrames double Identifies the total number of animation frames for a single-day or multi-day study.
P OwnerViewId ElementId The id of the view that owns the element. (Inherited from Element .) Element
P Parameter.Guid. Parameter Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element .) Element
P Parameter.BuiltInParameter. Parameter Retrieves a parameter from the element given a parameter id. (Inherited from Element .) Element
P Parameter.Definition. Parameter Retrieves a parameter from the element based on its definition. (Inherited from Element .) Element
P Parameters ParameterSet Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P ParametersMap ParameterMap Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P Pinned bool Identifies if the element has been pinned to prevent changes. (Inherited from Element .) Element
P ProjectLocationId ElementId Identifies the ProjectLocation element used by the SunAndShadowSettings element.
P ProjectLocationName string Identifies the name of the project location used by the SunAndShadowSettings element.
P RelativeToView bool Identifies whether the SunAndShadowSettings element is relative to the view direction. This is only relevant for lighting mode.
P SharesSettings bool Identifies whether settings are shared globally.
P StartDateAndTime DateTime Identifies the start or current date and time.
P SunAndShadowType SunAndShadowType Identifies the type of the SunAndShadowSettings element.
P SunriseToSunset bool Identifies whether the current single day sun study is set to run from sunrise to sunset.
P TimeInterval SunStudyTimeInterval Identifies the time interval between animation frames.
P TimeZone double Identifies the time zone.
P UniqueId string A stable unique identifier for an element within the document. (Inherited from Element .) Element
P UsesDST bool Identifies whether the SunAndShadowSettings element is using daylight savings time.
P UsesGroundPlane bool Identifies whether the SunAndShadowSettings element uses a ground plane.
P VersionGuid Guid Get the element version Guid. (Inherited from Element .) Element
P ViewSpecific bool Identifies if the element is owned by a view. (Inherited from Element .) Element
P Visible bool Visibility in current view for a per-view SunAndShadowSettings element.
P WorksetId WorksetId Get Id of the Workset which owns the element. (Inherited from Element .) Element