ScheduleField.PercentageOf

Public Property

The ID of the field to calculate percentages of.

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public ScheduleFieldId PercentageOf { get; set; }

Property Value

ScheduleFieldId
The ID of the field, or InvalidElementId.

Exceptions

Exception

Condition

---

ArgumentException

When setting this property: percentageOf is not InvalidScheduleFieldId or the ID of a field that can be used to calculated percentages. -or- When setting this property: percentageOf would create a circular chain of references.

---

ArgumentNullException

When setting this property: A non-optional argument was null

---

InvalidOperationException

When setting this property: This ScheduleField is not a percentage field.

---

Remarks

A Percentage field calculates what percent of the total of another field each element represents. PercentageOf is the ID of the field used to calculate percentages. If PercentageOf is InvalidScheduleFieldId, no data is displayed.

Percentages can only be calculated for numeric fields. The Count field and other percentage fields cannot be used to calculate percentages.