VS:GetPenFore

From Vectorworks Developer
Jump to navigation Jump to search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Procedure GetPenFore returns the pen foreground color components of the referenced object. RGB values are in the range of 0~65535.

PROCEDURE GetPenFore(
h :HANDLE;
VAR red :LONGINT;
VAR green :LONGINT;
VAR blue :LONGINT);
def vs.GetPenFore(h):
    return (red, green, blue)

Parameters

h HANDLE Handle to object.
red LONGINT Returns RGB color component value.
green LONGINT Returns RGB color component value.
blue LONGINT Returns RGB color component value.

Example

VectorScript

GetPenFore(handleToObject,redValue,greenValue,blueValue);

Python

red_value, green_value, blue_value = vs.GetPenFore(handleToObject)

Version

Availability: from MiniCAD6.0

See Also

VS Functions: VS:ColorIndexToRGB | VS:RGBToColorIndex | VS:GetPenBack | VS:GetFillFore | VS:GetFillBack

VS Functions: [[VS:ColorIndexToRGB]] | [[VS:RGBToColorIndex]] | [[VS:GetPenBack]] | [[VS:GetFillFore]] | [[VS:GetFillBack]]