NumberingFormatSettings

Description:
Settings associated with the formatting of a numbering schema.

Remarks:

This object contains all the formatting settings related to a numbering schema. The final number available on the element is generated for the user based on the parameters set with GetParameters/SetParameters on this object. The order for this parameter is the order in which their values will appear in the generated number. All the transformations applied to this values that are available are controlled from the NumberingFormattedParameter set with the above methods. The value assigned by the system will have the position of the parameter with the same id as the NumberingParameterId on the NumberingSchema. The AsCharacters property controls if in the final output the value assigned by the system will be presented as a set of letter(ex A for 1, B for 2, AA for 20) The MinimumNumberOfDigits property determines the minimum number of digits that will be used for the value assigned for the system if AsCharacters is false.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.NumberingFormatSettings

public class NumberingFormatSettings : IDisposable

Public Class NumberingFormatSettings
	Implements IDisposable

public ref class NumberingFormatSettings : IDisposable

type NumberingFormatSettings = 
    class
        interface IDisposable
    end

Name	Return Type	Description	Inherited From
C NumberingFormatSettings()	None	Create an empty NumberingFormatSettings object.
C NumberingFormatSettings(NumberingFormatSettings)	None	Copy a parameter and its association.

Name	Return Type	Description	Inherited From
M Dispose()	None	Releases all resources used by the NumberingFormatSettings
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetParameter(Int32)	NumberingFormattedParameter	Get the parameter at the provided index incorporated into the numeric label.
M GetParameters()	IList<NumberingFormattedParameter>	Get parameters incorporated into the numeric label.
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M RemoveParameter(Int32)	None	Remove a parameter from a specific index. The position where the parameter to be removed.
M SetParameter(NumberingFormattedParameter, Int32)	None	Set parameter incorporated into the numeric label. Parameter to be added into the label The position where the parameter to be added
M SetParameters(IList<NumberingFormattedParameter>)	None	Set parameters incorporated into the numeric label.
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description
P AsCharacters	bool	True if the number is using characters, false for digits.
P FirstNumberFormattingOption	FirstNumberFormattingOptions	The formatting options for the start of a sequence.
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P MinimumNumberOfDigits	int	Defines the minimum digit count for the numerical display.
P NumberOfParameters	int	A property defining the number of parameters used in this formatting settings object.
P UppercaseCharacters	bool	if asCharacters is enabled, the characters will be presented as uppercase.