topic Re: Revit Schedule - Title/headers in Revit API Forum

Revit Schedule - Title/headers

travis_cadnetics — Fri, 07 Nov 2014 20:14:33 GMT

In Revit the Schedule defines specific areas by name. Title, Headers, Body.

The API does not seem to be consistant with this data. If you export api header data, Im getting schedule "Title". The schedule "Headers" are part of the body data.

Has anyone else come to the same conclusion?

The Enumneration for the sectionTypes seem likes it should be: None, Title, Headers, Body, Summary, Footer (and..there should even be a Grouping Header and a Grouping Footer, but thats not the point of this post).

Re: Revit Schedule - Title/headers

jeremytammik — Wed, 12 Nov 2014 07:31:12 GMT

Dear Tjohnson,

Thank you for your query.

I am discussing it with the development team.

I hope this helps.

Best regards,

Jeremy

Re: Revit Schedule - Title/headers

jeremytammik — Thu, 13 Nov 2014 08:25:51 GMT

Dear Tjohnson,

I heard back from the development team, and they say:

It's complicated. Are you sitting down for this?

The TableView and related TableData classes are more generic than just regular view schedules. For example, they also support PanelViewSchedules for the electrical discipline, which are also a grid-like organization of data, text and images, but offer different options to layout and edit the contents.

Because this is a more generic framework than regular Revit schedules, and regular Revit schedules existed and were migrated into this framework, there are some design compromises in place and this question is centered around one of those design compromises. Specifically, the entire Revit-generated grid with the parameter content which makes up the 'schedule' has been placed in the Body section of the TableView. This includes the generated column headers and grouped headers, the generated text, and even the blank spaces in between 'sections' of the Revit schedule. So if you use the TableView and related APIs to iterate over the cell-by-cell contents of the Body, you get almost everything that is in the schedule.

In fact, regular schedules do have a separate section for the title, which is the Header section. Nominally when the schedule is created this is just the title in a single cell, but you have tools on the ribbon to insert new rows and columns, merge cells, insert images, etc. (And this is also possible using the API). So the header of a standard Revit schedule can contain much more than just the title, but it does not include the columns supplied by the information (e.g. the list of parameters) in the ScheduleDefinition.

I hope this helps.

Best regards,

Re: Revit Schedule - Title/headers

travis_cadnetics — Thu, 13 Nov 2014 14:06:11 GMT

That makes sense to me. As someone who is new to Coding and the Revit API, I just wanted to be sure I was understanding the results that I was getting. I assume that this was the case when I searched the SDK Documentation received results for either the Panel Schedule or the regular schedule data. Thanks for the clarification.

Re: Revit Schedule - Title/headers

Anonymous — Thu, 27 Apr 2017 13:26:39 GMT

I need to change all schedule header text to upper case. Is this possible?

Thanks in advance,

Scott

Re: Revit Schedule - Title/headers

Anonymous — Wed, 11 Apr 2018 16:57:37 GMT

Do you have an example of how to modify the header (insert in line and columns and inserting text in the cells)?
Greetings Håkon Frank

Re: Revit Schedule - Title/headers

RustyHyde — Fri, 19 Oct 2018 17:13:10 GMT

I know this is very old but I need an answer to this as well.

Re: Revit Schedule - Title/headers

Anonymous — Wed, 31 Oct 2018 16:27:07 GMT

Thanks, I got it to work.

Re: Revit Schedule - Title/headers

Anonymous — Thu, 31 Oct 2019 06:53:22 GMT

How? I also need to modify the headers based on our standard schedule.

Re: Revit Schedule - Title/headers

zhounnin — Tue, 18 May 2021 01:20:18 GMT

is it possible to modify text inside header?

Re: Revit Schedule - Title/headers

brownbr2VHQE — Thu, 04 Aug 2022 16:35:37 GMT

Care to share your method?

Re: Revit Schedule - Title/headers

H.echeva — Wed, 23 Nov 2022 14:24:31 GMT

Hello,

I found this post which was very helpful, thank you @Anonymous for the info.

I have created a small example macro that gets the Header text (it is very basic and may need to be made safer). I hope this helps

/// <summary> /// This macro gets the header text of the active Schedule View /// </summary> public void ScheduleHeader() { UIDocument uidoc = this.ActiveUIDocument; Document doc = uidoc.Document; ViewSchedule mySchedule = uidoc.ActiveView as ViewSchedule; TableData myTableData = mySchedule.GetTableData(); TableSectionData myData = myTableData.GetSectionData(SectionType.Header); TaskDialog.Show("Header Info", "The Header Text is: \n" +myData.GetCellText(0,0)); }

Re: Revit Schedule - Title/headers

jeremy_tammik — Wed, 23 Nov 2022 16:07:41 GMT

Thank you for kindly sharing your implementation, Hernan! I hope that will help resolve the4 issue for all the others above.

Re: Revit Schedule - Title/headers

ekaterina.kudelina93H47 — Mon, 17 Jun 2024 14:29:20 GMT

There is a possibility to rename column header within Body section using ScheduleDefinition.ColumnHeading, the property has setter as well. Conserning getting value of a Body section cell, from my experience, it is to use method GetCellText of class ViewSchedule rather than the same method of class SectionData (the second one always returned me empty string). Also for complex headers (merged/groupped) I played around with methods ViewSection.GroupHeaders/UngroupHeaders (it allows to set new text) and SectionData.GetMergedCell to detect if a cell is a part of merging.