ClassesClassesClassesClasses | | | | Operators

set_line_widthset_line_widthSetLineWidthset_line_widthSetLineWidthSetLineWidth (Operator)

Name

set_line_widthset_line_widthSetLineWidthset_line_widthSetLineWidthSetLineWidth — Define the line width for region contour output.

Signature

set_line_width( : : WindowHandle, Width : )

Herror set_line_width(const Hlong WindowHandle, const Hlong Width)

Herror T_set_line_width(const Htuple WindowHandle, const Htuple Width)

Herror set_line_width(const HTuple& WindowHandle, const HTuple& Width)

void HWindow::SetLineWidth(const HTuple& Width) const

void SetLineWidth(const HTuple& WindowHandle, const HTuple& Width)

void HWindow::SetLineWidth(Hlong Width) const

void HOperatorSetX.SetLineWidth(
[in] VARIANT WindowHandle, [in] VARIANT Width)

void HWindowX.SetLineWidth([in] Hlong Width)

static void HOperatorSet.SetLineWidth(HTuple windowHandle, HTuple width)

void HWindow.SetLineWidth(int width)

Description

set_line_widthset_line_widthSetLineWidthset_line_widthSetLineWidthSetLineWidth defines the line width (in pixel) in which a region contour is displayed (e.g. with disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion, disp_linedisp_lineDispLinedisp_lineDispLineDispLine, disp_polygondisp_polygonDispPolygondisp_polygonDispPolygonDispPolygon, etc.) The operator get_line_widthget_line_widthGetLineWidthget_line_widthGetLineWidthGetLineWidth returns the current value for the window. Some output devices may not allow to change the contour width. If it is possible for the current device, it can be queried with query_line_widthquery_line_widthQueryLineWidthquery_line_widthQueryLineWidthQueryLineWidth.

Attention

The line width is important if the output mode was set to 'margin' (see set_drawset_drawSetDrawset_drawSetDrawSetDraw). If the line width is greater than one, regions may not always be displayed correctly.

Parallelization

Parameters

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

Window_id.

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

Line width for region output in contour mode.

Default value: 1

Restriction: Width >= 1 && Width <= 2000

Result

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

Possible Predecessors

query_line_widthquery_line_widthQueryLineWidthquery_line_widthQueryLineWidthQueryLineWidth, get_line_widthget_line_widthGetLineWidthget_line_widthGetLineWidthGetLineWidth

Possible Successors

disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion

See also

get_line_widthget_line_widthGetLineWidthget_line_widthGetLineWidthGetLineWidth, query_line_widthquery_line_widthQueryLineWidthquery_line_widthQueryLineWidthQueryLineWidth, set_drawset_drawSetDrawset_drawSetDrawSetDraw, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion

Module

Foundation


ClassesClassesClassesClasses | | | | Operators