Represents a NXOpen.PlotColorsWidthsBuilder to be used for plotting. More...

Inheritance diagram for NXOpen.PlotColorsWidthsBuilder:

Public Types
enum	Color { AsDisplayed, PartColors, CustomPalette, BlackOnWhite, LegacyColors, ColorsByWidth }
	Specifies the color option to use when plotting. More...

enum	Width { StandardWidths, SingleWidth, CustomThreeWidths, CustomPalette }
	Specifies the primary selection of which type of width assignment to use. More...

Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
unsafe void	DefinePalette ()
	Initialize the Color Palette. More...

unsafe void	DefineWidths ()
	Initialize the Width dialog. More...

unsafe void	RetrieveColors ()
	Retrieve drawing sheet colors More...

unsafe void	SaveColors ()
	Save drawing sheet colors More...

unsafe void	EditColors ()
	Edit drawing sheet colors More...

unsafe void	DeleteColors ()
	Delete drawing sheet colors More...

unsafe void	ResetColors ()
	Reset drawing sheet colors More...

unsafe void	RetrieveWidths ()
	Retrieve drawing sheet widths More...

unsafe void	SaveWidths ()
	Save drawing sheet widths More...

unsafe void	EditWidths ()
	Edit drawing sheet widths More...

unsafe void	DeleteWidths ()
	Delete drawing sheet widths More...

unsafe void	ResetWidths ()
	Reset drawing sheet widths More...

unsafe NXOpen.CDF	CreateCdf ()
	Creates and returns a NXOpen.CDF object representing the Color Palette. More...

unsafe NXOpen.CDF	GetCdf ()
	Returns a NXOpen.CDF object representing the Color Palette. More...

unsafe NXOpen.WidthDefinition	CreateWidthDefinition ()
	Creates and returns a NXOpen.WidthDefinition object representing the Width Palette. More...

unsafe NXOpen.WidthDefinition	GetWidthDefinition ()
	Returns a NXOpen.WidthDefinition object representing the Width Palette. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

Properties
unsafe NXOpen.PlotColorsWidthsBuilder.Color	Colors `[get, set]`
	Returns or sets the color option to be used when plotting. More...

unsafe bool	UseDrawingSheetColors `[get, set]`
	Returns or sets the use drawing sheet colors. More...

unsafe bool	UseDrawingSheetWidths `[get, set]`
	Returns or sets the use drawing sheet widths. More...

unsafe NXOpen.PlotColorsWidthsBuilder.Width	Widths `[get, set]`
	Returns or sets the width option. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Detailed Description

Represents a NXOpen.PlotColorsWidthsBuilder to be used for plotting.

The PlotColorsWidthsBuilder class maintains all colors and widths data, which will be used by the PlotBuilder. If the color option is set to Custom Palette or Colors By Width, the PlotBuilder will translate the CDF object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined colors. If the width option is set to Single Width, Custom Three Width, or Custom Palette, the PlotBuilder will translate the WidthDefinition object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined widths.

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.PlotColorsWidthsBuilder.Color

Specifies the color option to use when plotting.

Enumerator
AsDisplayed	As Displayed
PartColors	Part Colors
CustomPalette	Custom Palette
BlackOnWhite	Black on White
LegacyColors	Legacy Colors
ColorsByWidth	Colors by Width

enum NXOpen.PlotColorsWidthsBuilder.Width

Specifies the primary selection of which type of width assignment to use.

Enumerator
StandardWidths	Standard Widths
SingleWidth	Single Width
CustomThreeWidths	Custom Three Widths
CustomPalette	Custom palette

Member Function Documentation

unsafe NXOpen.CDF NXOpen.PlotColorsWidthsBuilder.CreateCdf ( )

Creates and returns a NXOpen.CDF object representing the Color Palette.

This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option.

Created in NX5.0.0

License requirements: None.

Returns: CDF object

unsafe NXOpen.WidthDefinition NXOpen.PlotColorsWidthsBuilder.CreateWidthDefinition ( )

Creates and returns a NXOpen.WidthDefinition object representing the Width Palette.

This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.

Created in NX5.0.0

License requirements: None.

Returns: WidthDefinition object

unsafe void NXOpen.PlotColorsWidthsBuilder.DefinePalette ( )

Initialize the Color Palette.

This allows the user to change the attributes of any color. These changed colors will be used if Custom Palette or Colors By Width is selected as the color option.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.DefineWidths ( )

Initialize the Width dialog.

This allows the user to change the attributes of Single Width, Custom Three Widths, or Custom Palette. These changed width values will be used depending on the width option selected.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.DeleteColors ( )

Delete drawing sheet colors

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.DeleteWidths ( )

Delete drawing sheet widths

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.EditColors ( )

Edit drawing sheet colors

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.EditWidths ( )

Edit drawing sheet widths

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.CDF NXOpen.PlotColorsWidthsBuilder.GetCdf ( )

Returns a NXOpen.CDF object representing the Color Palette.

This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option.

Created in NX5.0.0

License requirements: None.

Returns: CDF object

unsafe NXOpen.WidthDefinition NXOpen.PlotColorsWidthsBuilder.GetWidthDefinition ( )

Returns a NXOpen.WidthDefinition object representing the Width Palette.

This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.

Created in NX5.0.0

License requirements: None.

Returns: WidthDefinition object

unsafe void NXOpen.PlotColorsWidthsBuilder.ResetColors ( )

Reset drawing sheet colors

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.ResetWidths ( )

Reset drawing sheet widths

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.RetrieveColors ( )

Retrieve drawing sheet colors

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.RetrieveWidths ( )

Retrieve drawing sheet widths

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.SaveColors ( )

Save drawing sheet colors

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotColorsWidthsBuilder.SaveWidths ( )

Save drawing sheet widths

Created in NX5.0.0

License requirements: None.

Property Documentation

unsafe NXOpen.PlotColorsWidthsBuilder.Color NXOpen.PlotColorsWidthsBuilder.Colors

getset

Returns or sets the color option to be used when plotting.

If the color option is set to Custom Palette or Colors By Width then the plotter will use the user defined color attributes belonging to the CDF object.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PlotColorsWidthsBuilder.UseDrawingSheetColors

getset

Returns or sets the use drawing sheet colors.

When this option is set to true, the plotter will use the user-defined drawing sheet colors.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PlotColorsWidthsBuilder.UseDrawingSheetWidths

getset

Returns or sets the use drawing sheet widths.

When this option is set to true, the plotter will use the user-defined drawing sheet widths.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotColorsWidthsBuilder.Width NXOpen.PlotColorsWidthsBuilder.Widths

getset

Returns or sets the width option.

If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the plotter will use the user defined width attributes belonging to the WidthDefinition object.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

The documentation for this class was generated from the following file:

dotnet_pool/PlotColorsWidthsBuilder.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation