RenderingPropertiesBuilder Class

class NXOpen.Diagramming.RenderingPropertiesBuilder

Bases: NXOpen.Diagramming.BaseSubObjectBuilder

Represents a RenderingPropertiesBuilder.

This is a sub-builder class and cannot be directly instantiated

New in version NX10.0.0.

Properties

Property Description
FillColor Returns or sets the fill color.
FillOpacity Returns or sets the fill opacity.
LineFont Returns or sets the line font.
LineWidth Returns or sets the line width.
StrokeColor Returns or sets the stroke color.
StrokeOpacity Returns or sets the stroke opacity.
Tag Returns the Tag for this object.

Methods

Method Description
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

FillColor

RenderingPropertiesBuilder.FillColor

Returns or sets the fill color.

-------------------------------------

Getter Method

Signature FillColor

Returns:
Return type:Id

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FillColor

Parameters:colorId (Id) –

New in version NX10.0.0.

License requirements: None.

FillOpacity

RenderingPropertiesBuilder.FillOpacity

Returns or sets the fill opacity.

The range of opacity is from 0.0 to 1.0. 0.0 is completely transparent and 1.0 is completely opaque.

-------------------------------------

Getter Method

Signature FillOpacity

Returns:
Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FillOpacity

Parameters:opacity (float) –

New in version NX10.0.0.

License requirements: None.

LineFont

RenderingPropertiesBuilder.LineFont

Returns or sets the line font.

-------------------------------------

Getter Method

Signature LineFont

Returns:
Return type:NXOpen.DisplayableObjectObjectFont

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LineFont

Parameters:font (NXOpen.DisplayableObjectObjectFont) –

New in version NX11.0.1.

License requirements: None.

LineWidth

RenderingPropertiesBuilder.LineWidth

Returns or sets the line width.

-------------------------------------

Getter Method

Signature LineWidth

Returns:
Return type:NXOpen.DisplayableObjectObjectWidth

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LineWidth

Parameters:width (NXOpen.DisplayableObjectObjectWidth) –

New in version NX11.0.1.

License requirements: None.

StrokeColor

RenderingPropertiesBuilder.StrokeColor

Returns or sets the stroke color.

-------------------------------------

Getter Method

Signature StrokeColor

Returns:
Return type:Id

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StrokeColor

Parameters:colorId (Id) –

New in version NX10.0.0.

License requirements: None.

StrokeOpacity

RenderingPropertiesBuilder.StrokeOpacity

Returns or sets the stroke opacity.

The range of opacity is from 0.0 to 1.0. 0.0 is completely transparent and 1.0 is completely opaque.

-------------------------------------

Getter Method

Signature StrokeOpacity

Returns:
Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StrokeOpacity

Parameters:opacity (float) –

New in version NX10.0.0.

License requirements: None.

Method Detail

Validate

RenderingPropertiesBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.