VS:PenBack: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(add remark and python example) |
||
| Line 29: | Line 29: | ||
</lineList> | </lineList> | ||
</params> | </params> | ||
----------------------------------------------------------------------------------------------------------- | |||
<remark> | |||
[[User:Orso.b.schmid| Orso]]: This Procedure will also accept a single INTEGER Color Palette Index value in lieu of three LONGINT RGB values for the COLOR parameter. The Color index can be obtained with [[VS:RGBToColorIndex]]. See remarks under [[VS:SetPenFore]] for more infos. On Vectorlab there is a list of all color routines accepting multiple variable type, see: [http://www.vectorlab.info/index.php?title=Index_pitfalls#Colors Color Index]. | |||
</remark> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<sample> | <sample> | ||
==== VectorScript ==== | ==== VectorScript ==== | ||
<code lang="pas"> | <code lang="pas"> | ||
PenBack(65535,0,39321); | PenBack(65535, 0, 39321); | ||
</code> | </code> | ||
==== Python ==== | ==== Python ==== | ||
<code lang="py"> | <code lang="py"> | ||
vs.PenBack((65535, 0, 39321)); | |||
</code> | </code> | ||
</sample> | </sample> | ||
Revision as of 04:50, 19 May 2015
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Procedure PenBack set the active pen background color for the document. RGB values are in the range of 0~65535.
PROCEDURE PenBack(
color :LONGINT);
def vs.PenBack(color):
return None
Parameters
color LONGINT RGB color value to be set as active pen background.
Remarks
Orso: This Procedure will also accept a single INTEGER Color Palette Index value in lieu of three LONGINT RGB values for the COLOR parameter. The Color index can be obtained with VS:RGBToColorIndex. See remarks under VS:SetPenFore for more infos. On Vectorlab there is a list of all color routines accepting multiple variable type, see: Color Index.
Example
VectorScript
PenBack(65535, 0, 39321);
Python
vs.PenBack((65535, 0, 39321));
Version
Availability: from All Versions
See Also
VS Functions:
VS:RGBToColorIndex | VS:ColorIndexToRGB
VS Functions:
[[VS:RGBToColorIndex]]
| [[VS:ColorIndexToRGB]]