topic Re: Get ViewSheet from View in Revit API Forum

Get ViewSheet from View

Anonymous — Wed, 10 May 2017 19:58:10 GMT

Is there a way to get the ViewSheet or ElementId of the ViewSheet from a View that is placed on that sheet? I can get the sheet name and sheet number from the provided parameters but do not see one for the actual ViewSheet. Am I missing something? The only thing i can think of to do without this info is to loop through all ViewSheets to match the one with the same sheet number (since sheet number is required to be unique). Thanks.

Re: Get ViewSheet from View

jeremytammik — Wed, 10 May 2017 20:55:57 GMT

Dear Michael,

Thank you for your query.

Have you looked at the sample code provided in the description of the ViewSheet class?

http://www.revitapidocs.com/2017/af2ee879-173d-df3a-9793-8d5750a17b49.htm

  ICollection<ElementId> views = viewSheet.GetAllPlacedViews();
  message += "\nNumber of views in the sheet : " + views.Count;

If all else fails, you could use this relationship and invert it.

The View.Title property also generally consists of the view name plus other modifiers, such as the view type, sheet number, area scheme, and/or assembly type, depending on the specifics of the view:

http://www.revitapidocs.com/2017/bfa96650-310e-5385-3a9d-1a1248b623ce.htm

I hope this helps.

Best regards,

Jeremy

Re: Get ViewSheet from View

Anonymous — Thu, 11 May 2017 13:02:40 GMT

Hi Jeremy,

You must have misunderstood my question. I don't have the ViewSheet in order to use the method to get its placed views. I have a view, that I know is on a sheet (because its sheet number parameter is not null), but I want to get a direct reference to that sheet that it is placed on. It seems to me that you are still suggesting that I must loop through all ViewSheets to get the View that I'm concerned with. Thanks.

Re: Get ViewSheet from View

respresso — Tue, 04 Feb 2020 08:13:17 GMT

You can perhaps get VIEWPORT_SHEET_NUMBER from Parameters.

Re: Get ViewSheet from View

jeremytammik — Tue, 04 Feb 2020 08:35:47 GMT

Dear Michael,

Thank you for your patience.

The new answer from respresso brought this issue to my attention again.

You say: It seems to me that you are still suggesting that I must loop through all ViewSheets to get the View that I'm concerned with.

Yes, indeed, that is exactly what I am suggesting.

Get all the view sheets, keep track of them and the views they host, and invert that relationship, as described in one of the very early discussions by The Building Coder back in 2008 on a relationship inverter:

http://thebuildingcoder.typepad.com/blog/2008/10/relationship-in.html

I hope this helps.

Best regards,

Jeremy

Re: Get ViewSheet from View

so-chong — Tue, 04 Feb 2020 17:56:53 GMT

Hi,

Thank you Jeremy and respresso for bringing this topic to my attention.

I was not aware this question was raised a few years ago.

I maybe have a workaround for this question, something similar i assume.

Select some views in the Project Browser to know if the views are placed on sheet(s).

Then, run a macro or IExternalcommand to execute the command, something like inserted (macro)code as an example;
If view is placed on Sheet, then show the sheetnumber, sheetname or whatever data you interested in of the ViewSheet that is referenced to the selected views in the Project Browser.

Hope this is useful for you or point you to the right direction.

    public void GetViewSheetFromView()
    {
        UIDocument uidoc = this.ActiveUIDocument;
        Document doc = uidoc.Document;            
        string data = "";
        
        ICollection<ElementId> selectedIds = uidoc.Selection.GetElementIds();
        
        foreach (ElementId selectedid in selectedIds)
        {            
            View e = doc.GetElement(selectedid) as View;
            
            foreach (View v in new FilteredElementCollector(doc).OfClass(typeof(View)).Cast<View>().Where(q => q.Id.Equals(e.Id)))
            {
                string thisSheet = "";
                foreach (ViewSheet vs in new FilteredElementCollector(doc).OfClass(typeof(ViewSheet)).Cast<ViewSheet>())
                {
                    foreach (ElementId eid in vs.GetAllPlacedViews())
                    {
                        View ev = doc.GetElement(eid) as View;
                        if(ev.Id == v.Id)
                        {
                            thisSheet += vs.SheetNumber + " - " + vs.Name + Environment.NewLine ;
                            break;
                        }
                    }
                }
                
                if (thisSheet != "")
                {
                    data += v.ViewType + ": " + v.Name + " " + Environment.NewLine + thisSheet.TrimEnd(' ',',') + Environment.NewLine;
                }
                
                else
                {
                    data +=  v.ViewType + ": " + v.Name + " " + Environment.NewLine + thisSheet.TrimEnd(' ',',');
                    data += " NOT ON SHEET " +   Environment.NewLine + "\n" ;                        
                }
            }
        }
        TaskDialog.Show("View Report", data);
    }

Re: Get ViewSheet from View

RPTHOMAS108 — Tue, 04 Feb 2020 22:43:12 GMT

As respresso suggests using the BIP for viewport sheet number with an ElementParameterFilter is probably the best approach. Sheet numbers are unique in each Revit model so it is safe to search by them and get the right result.

 Public Function TObj43(ByVal commandData As Autodesk.Revit.UI.ExternalCommandData, _
              ByRef message As String, ByVal elements As Autodesk.Revit.DB.ElementSet) As Result

        If commandData.Application.ActiveUIDocument Is Nothing Then Return Result.Cancelled Else 
        Dim AcView As View = commandData.Application.ActiveUIDocument.ActiveGraphicalView

        Dim P_Ns As Parameter = AcView.Parameter(BuiltInParameter.VIEWPORT_SHEET_NUMBER)
        If P_Ns Is Nothing Then
            GoTo Monday
        End If

        Dim Txt As String = P_Ns.AsString
        If String.IsNullOrEmpty(Txt) Then GoTo Monday Else 
        Dim SeFR As FilterRule = ParameterFilterRuleFactory.CreateEqualsRule(New ElementId(BuiltInParameter.SHEET_NUMBER), Txt, True)
        Dim PFilt As New ElementParameterFilter(SeFR, False)

        Dim FEC As New FilteredElementCollector(AcView.Document)
        Dim ECF As New ElementClassFilter(GetType(ViewSheet))
        Dim LandF As New LogicalAndFilter(ECF, PFilt)
        Dim Els As List(Of Element) = FEC.WherePasses(LandF).ToElements

        If Els.Count <> 1 Then
            GoTo Monday
        Else
            Dim TD As New TaskDialog("Was this your sheet...")
            TD.MainInstruction = Txt & "-" & Els(0).Name
            TD.MainContent = "Note that view types that can appear on multiple sheets (Legends, Images, Schedules etc.) will not be returned by this method."
            TD.Show()
            GoTo Friday
        End If
Monday:
        TaskDialog.Show("Something went amiss...", "We looked hard in many places but were unable to find your sheet on this occasion.")
        Return Result.Failed
Friday:
        Return Result.Succeeded
    End Function

Re: Get ViewSheet from View

TorsionTools — Wed, 05 Feb 2020 13:01:27 GMT

Here is a pretty quick way of checking for a specific sheet.

        private ViewSheet CheckSheet(string _sheetNumber)
        {
            ParameterValueProvider pvp = new ParameterValueProvider(new ElementId(BuiltInParameter.SHEET_NUMBER));
            FilterStringRuleEvaluator fsr = new FilterStringEquals();
            FilterRule fRule = new FilterStringRule(pvp, fsr, _sheetNumber, true);
            ElementParameterFilter filter = new ElementParameterFilter(fRule);

            if (new FilteredElementCollector(doc).OfCategory(BuiltInCategory.OST_Sheets).WherePasses(filter).FirstOrDefault() is ViewSheet vs)
            {
                return vs;
            }
            else
            {
                return null;
            }
        }

Re: Get ViewSheet from View

jeremytammik — Wed, 05 Feb 2020 15:18:07 GMT

I believe this solution is unbeatable if you are interested in one single lookup.

It uses a parameter filter and the SHEET_NUMBER built-in parameter.

Probably RPThomas' solution is similarly efficient.

So-chong demonstrates the lookup of the inverted relationship I described, but just for one single view.

His code could be used to store the entire sheet to hosted views and the inverted view to hosting sheet relationships for all views and sheets. That might possibly be more efficient if you frequently need to look up several different view to sheet relationships.

Thank you all for the very illuminating and helpful answers!

Cheers,

Jeremy

Re: Get ViewSheet from View

jeremytammik — Thu, 13 Feb 2020 10:22:33 GMT

Thanks again for the interesting discussion.

Now summarised and cleaned up for posterity:

https://thebuildingcoder.typepad.com/blog/2020/02/get-title-block-data-and-viewsheet-from-view.html

Re: Get ViewSheet from View

Erik_Frits — Fri, 23 Jul 2021 15:38:48 GMT

For every python developer out there still looking for a solution:

You can use my snippet made with FilteredElementCollector and FilterStringRule:

https://www.erikfrits.com/blog/get-viewsheet-from-given-view-with-filteredelementcollector-and-filterstringrule/

Re: Get ViewSheet from View

jeremy_tammik — Mon, 06 Sep 2021 16:28:36 GMT

Thank you for sharing your Python solution! Edited and preserved for posterity on the blog:

https://thebuildingcoder.typepad.com/blog/2021/09/view-sheet-from-view-and-select-all-on-level.html#4

Re: Get ViewSheet from View

Michael_Coffey_G — Thu, 03 Apr 2025 17:05:29 GMT

Why can't Autodesk just provide a simple property that is the sheet's ElementId? Is it really that hard? Sheet collections are now another problem that have to be contended with.

Re: Get ViewSheet from View

jeremy_tammik — Thu, 03 Apr 2025 17:26:48 GMT

Please submit a wish for this in the Revit Idea Station. Thank you!

Re: Get ViewSheet from View

mwagnerfrey6 — Fri, 19 Sep 2025 14:45:54 GMT

Here is a version that will work for Legends and Schedules.

public static class ViewExtensions { /// <summary> /// Tests if the view is a view that represents the model rather than a drafting view or schedule. /// </summary> /// <param name="view">The view to test.</param> /// <returns> <see langword="true"/> for views of types /// <see cref="Autodesk.Revit.DB.ViewType.FloorPlan"/>, /// <see cref="Autodesk.Revit.DB.ViewType.EngineeringPlan"/>, /// <see cref="Autodesk.Revit.DB.ViewType.AreaPlan"/>, /// <see cref="Autodesk.Revit.DB.ViewType.CeilingPlan"/>, /// <see cref="Autodesk.Revit.DB.ViewType.Elevation"/>, /// <see cref="Autodesk.Revit.DB.ViewType.Section"/>, or /// <see cref="Autodesk.Revit.DB.ViewType.ThreeD"/>. /// <see langword="false"/> otherwise. /// </returns> public static bool IsAModelView(this View view) { return view.ViewType switch { ViewType.FloorPlan or ViewType.EngineeringPlan or ViewType.AreaPlan or ViewType.CeilingPlan or ViewType.Elevation or ViewType.Section or ViewType.ThreeD => true, _ => false, }; } /// <summary> /// Gets the sheet that this view is placed on, or <see langword="null"/> if not placed. /// For legends or schedules that may appear on multiple sheets, only the first is returned. /// </summary> /// <returns> /// The first found sheet that this view is placed on, or <see langword="null"/> if not placed. /// </returns> public static ViewSheet? GetSheet(this View? view) { return view.GetSheets().FirstOrDefault(); } /// <summary> /// Gets all sheets that this view is placed on. Returns an empty collection if not placed. /// Handles regular views (via Viewport), legends, and schedules. /// </summary> /// <returns> /// An IEnumerable of ViewSheets containing the view, or an empty IEnumerable if there are no ViewSheets containing the view /// </returns> public static IEnumerable<ViewSheet> GetSheets(this View? view) { if (view is null) { return Enumerable.Empty<ViewSheet>(); } return view switch { PanelScheduleView panelScheduleView => GetSheetsForPanelSchedules(panelScheduleView), ViewSchedule viewSchedule => GetSheetsForSchedules(viewSchedule), View modelView when modelView.IsAModelView() => GetSheetsForViewViaSheetNumber(modelView), _ => GetSheetsForViewViaViewport(view), }; } private static ElementFilter CreateFilterBySheetNumber(string sheetNumber) { var sheetNumberParameterId = new ElementId(BuiltInParameter.SHEET_NUMBER); #if REVIT2023_OR_GREATER FilterRule filterBySheetNumberRule = ParameterFilterRuleFactory.CreateEqualsRule(sheetNumberParameterId, sheetNumber); #else FilterRule filterBySheetNumberRule = ParameterFilterRuleFactory.CreateEqualsRule(sheetNumberParameterId, sheetNumber, true); #endif ElementParameterFilter filterBySheetNumber = new ElementParameterFilter(filterBySheetNumberRule, false); ElementClassFilter isViewSheetFilter = new ElementClassFilter(typeof(ViewSheet)); LogicalAndFilter isViewSheetWithSheetNumberFilter = new LogicalAndFilter(isViewSheetFilter, filterBySheetNumber); return isViewSheetWithSheetNumberFilter; } private static IEnumerable<ViewSheet> GetSheetsForViewViaSheetNumber(View view) { Parameter? sheetNumberParameter = view.get_Parameter(BuiltInParameter.VIEWPORT_SHEET_NUMBER); string? sheetNumber = sheetNumberParameter?.AsString(); if (string.IsNullOrEmpty(sheetNumber)) { return Enumerable.Empty<ViewSheet>(); } ElementFilter filterBySheetNumber = CreateFilterBySheetNumber(sheetNumber!); FilteredElementCollector fec = new FilteredElementCollector(view.Document); IList<Element> viewSheets = fec.WherePasses(filterBySheetNumber).ToElements(); return viewSheets.Cast<ViewSheet>(); } private static IEnumerable<ViewSheet> GetSheetsForViewViaViewport(View view) { return new FilteredElementCollector(view.Document) .OfClass(typeof(Viewport)) .Cast<Viewport>() .Where(vp => vp.ViewId == view.Id) .Select(vp => view.Document.GetElement(vp.SheetId)) .OfType<ViewSheet>() .Distinct(); } private static IEnumerable<ViewSheet> GetSheetsForSchedules(ViewSchedule view) { return new FilteredElementCollector(view.Document) .OfClass(typeof(ScheduleSheetInstance)) .Cast<ScheduleSheetInstance>() .Where(ssi => ssi.ScheduleId == view.Id) .Select(ssi => view.Document.GetElement(ssi.OwnerViewId)) .OfType<ViewSheet>() .Distinct(); } private static IEnumerable<ViewSheet> GetSheetsForPanelSchedules(PanelScheduleView view) { return new FilteredElementCollector(view.Document) .OfClass(typeof(PanelScheduleSheetInstance)) .Cast<PanelScheduleSheetInstance>() .Where(pssi => pssi.ScheduleId == view.Id) .Select(pssi => view.Document.GetElement(pssi.OwnerViewId)) .OfType<ViewSheet>() .Distinct(); } }