PC-Dmis 2010 Object Library | Send comments on this topic. | See Object Hierarchy Chart
Colors Collection Members
See Also Overview

Collapse All Expand All

# Public Methods

Add | Adds the color object associated with CommandTypeOrColorSection parameter. If already exists the previous one is returned. This method creates a new color node associated with the specified Command Type ID or Color Section ID, returning a Color object for the added node. Once you add a node, you can then define the colors used for the Standard, Marked, Debug, and OutTol.
BuildColortable | Rebuild Color Table using the current colors. retuns the
DiscardChanges | Discard Color objects modification and restore previous ones All changes made to the Colors collection are done inside a temporary structure. To restore the saved values and overwrite any changes you made in the temporary structure, use this method.
GetColorTableColor | Returns a ColorTable color Returns the color specified by the colorIndex parameter from the template's color table.
IsAllowed | Checks if CommandTypeOrColorSection parameter is allowed in current PCDMIS configuration This checks whether or not the specified Command Type or Color Section ID is valid in the current PC-DMIS configuration. If it is valid, it returns TRUE.
Item | Returns color object associated with CommandTypeOrColorSection parameter This method returns a specified color object from the color table based on the UID1 and UID2 parameters entered.
SaveChanges | Saves Color objects modification All changes made to the Colors collection are done inside a temporary structure. This copies the changes made inside this temporary structure to the master colors structure, essentially saving your changes, making them permanent.
UsedColor | Returns the effective command type or color section used This returns the color currently associated with the defined Command Type ID or Color Section ID. If a color is not defined for a feature type, the parent color is recursively searched until the default color is reached.

# Public Properties

Application | Read Only: Returns object pointer of type Application This property represents the read-only PC-DMIS Application object. The Application object includes properties and methods that return top-level objects.
Background | Read/Write: Returns/Sets the Background color This property returns or sets the Background color for the report template's color tree.
Count | Read Only: Returns the number of color object defined in the collection This property returns the number of color nodes (Color objects) defined in the Colors collection (or color tree).
DimensionBackground | Read/Write: Returns/Sets the Dimension background color This property returns or sets the dimension background color for the template's color tree.
HighLightBackground | Read/Write: Returns/Sets the Highlight background color This property returns or sets the highlight background color for the template's color tree.
Modified | Read/Write: Returns/Sets modified flag This property returns or sets the report template's "modified" tag for its color tree.
NumTableColors | Read Only: Returns the Number of color defined in the color table This property returns the number of colors defined in the report template's color table.
Parent | Read Only: Returns object pointer to the Parent object This returns this object's parent object. In this case, this is the ReportTemplate object.

# See Also

Colors Overview

© Wilcox Associates, Inc. All Rights Reserved.

© 2010 All Rights Reserved.