•  

ShiftNumbers Method

Shifts all numbers in the sequence so the starting number has the given value.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 2015.0.0.0 (2015.0.0.0)
Since: 2015

Syntax

C# 
public void ShiftNumbers(
	string partition,
	int firstNumber
)
Visual Basic 
Public Sub ShiftNumbers ( _
	partition As String, _
	firstNumber As Integer _
)
Visual C++ 
public:
void ShiftNumbers(
	String^ partition, 
	int firstNumber
)

Parameters

partition
Type: System String
Name of the partition that identifies the sequence. The sequence must exist.
firstNumber
Type: System Int32
Value for the new first (lowest) number of the sequence.

Remarks

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 MaximumStartingNumber are considered invalid.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException The sequence partition does not exist in the schema.
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was NULL
Autodesk.Revit.Exceptions ArgumentOutOfRangeException firstNumber must be in range between 1 and MaximumStartingNumber.
Autodesk.Revit.Exceptions InvalidOperationException Either the schema or its document cannot be modified at present.

See Also