ClassesClassesClassesClasses | | | | Operators

set_coloredset_coloredSetColoredset_coloredSetColoredSetColored (Operator)

Name

set_coloredset_coloredSetColoredset_coloredSetColoredSetColored — Set multiple output colors.

Signature

set_colored( : : WindowHandle, NumberOfColors : )

Herror set_colored(const Hlong WindowHandle, const Hlong NumberOfColors)

Herror T_set_colored(const Htuple WindowHandle, const Htuple NumberOfColors)

Herror set_colored(const HTuple& WindowHandle, const HTuple& NumberOfColors)

void HWindow::SetColored(const HTuple& NumberOfColors) const

void SetColored(const HTuple& WindowHandle, const HTuple& NumberOfColors)

void HWindow::SetColored(Hlong NumberOfColors) const

void HOperatorSetX.SetColored(
[in] VARIANT WindowHandle, [in] VARIANT NumberOfColors)

void HWindowX.SetColored([in] Hlong NumberOfColors)

static void HOperatorSet.SetColored(HTuple windowHandle, HTuple numberOfColors)

void HWindow.SetColored(int numberOfColors)

Description

set_coloredset_coloredSetColoredset_coloredSetColoredSetColored is a shortcut for certain set_colorset_colorSetColorset_colorSetColorSetColor calls. It allows the user to display a region set in different colors. NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColors defines the number of colors that are used. Valid values for NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColors can be queried with query_coloredquery_coloredQueryColoredquery_coloredQueryColoredQueryColored. Furthermore, the list of available colors can be set with the operator set_system(::'graphic_colors',...:)set_system("graphic_colors",...)SetSystem("graphic_colors",...)set_system("graphic_colors",...)SetSystem("graphic_colors",...)SetSystem("graphic_colors",...). This must be done before opening the first output window.

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window_id.

NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColors (input_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Number of output colors.

Default value: 12

List of values: 3, 6, 12

Result

set_coloredset_coloredSetColoredset_coloredSetColoredSetColored returns 2 (H_MSG_TRUE) if NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColors is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

query_coloredquery_coloredQueryColoredquery_coloredQueryColoredQueryColored, set_colorset_colorSetColorset_colorSetColorSetColor

Possible Successors

disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion

See also

query_coloredquery_coloredQueryColoredquery_coloredQueryColoredQueryColored, set_colorset_colorSetColorset_colorSetColorSetColor, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion

Module

Foundation


ClassesClassesClassesClasses | | | | Operators