NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder Class Reference

Represents a LineTypeBuilder. More...

Inheritance diagram for NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::NXColorLineColor ()
 Returns the line color. More...
 
NXOpen::DisplayableObject::ObjectFont LineFont ()
 Returns the line font. More...
 
NXString LineTypeName ()
 Returns the name of the line type. More...
 
int LineTypePriority ()
 Returns the priority of the line type. More...
 
NXOpen::DisplayableObject::ObjectWidth LineWidth ()
 Returns the line width. More...
 
NXString ObjectId ()
 Returns the object Id of the line type. More...
 
void SetLineColor (NXOpen::NXColor *colorId)
 Sets the line color. More...
 
void SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the line font. More...
 
void SetLineTypeName (const NXString &name)
 Sets the name of the line type. More...
 
void SetLineTypeName (const char *name)
 Sets the name of the line type. More...
 
void SetLineTypePriority (int priority)
 Sets the priority of the line type. More...
 
void SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
 Sets the line width. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a LineTypeBuilder.


Created in NX11.0.1.

Member Function Documentation

NXOpen::NXColor* NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::LineColor ( )

Returns the line color.


Created in NX11.0.1.

License requirements : None

NXOpen::DisplayableObject::ObjectFont NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::LineFont ( )

Returns the line font.


Created in NX11.0.1.

License requirements : None

NXString NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::LineTypeName ( )

Returns the name of the line type.

It should be unique.
Created in NX11.0.1.

License requirements : None

int NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::LineTypePriority ( )

Returns the priority of the line type.

It should be greater than or equal to 0.
Created in NX11.0.1.

License requirements : None

NXOpen::DisplayableObject::ObjectWidth NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::LineWidth ( )

Returns the line width.


Created in NX11.0.1.

License requirements : None

NXString NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::ObjectId ( )

Returns the object Id of the line type.


Created in NX11.0.1.

License requirements : None

void NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::SetLineColor ( NXOpen::NXColor colorId)

Sets the line color.


Created in NX11.0.1.

License requirements : None

Parameters
colorIdcolorid
void NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::SetLineFont ( NXOpen::DisplayableObject::ObjectFont  font)

Sets the line font.


Created in NX11.0.1.

License requirements : None

Parameters
fontfont
void NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::SetLineTypeName ( const NXString name)

Sets the name of the line type.

It should be unique.
Created in NX11.0.1.

License requirements : None

Parameters
namename
void NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::SetLineTypeName ( const char *  name)

Sets the name of the line type.

It should be unique.
Created in NX11.0.1.

License requirements : None

Parameters
namename
void NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::SetLineTypePriority ( int  priority)

Sets the priority of the line type.

It should be greater than or equal to 0.
Created in NX11.0.1.

License requirements : None

Parameters
prioritypriority
void NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::SetLineWidth ( NXOpen::DisplayableObject::ObjectWidth  width)

Sets the line width.


Created in NX11.0.1.

License requirements : None

Parameters
widthwidth
virtual bool NXOpen::DiagrammingLibraryAuthor::LineTypeBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.