VS:GetTileBackgroundColor

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

Description

Gets the specified tile resource's background color.

PROCEDURE GetTileBackgroundColor(
                 tileHandle   :HANDLE;
                 VAR red      :LONGINT;
                 VAR green    :LONGINT;
                 VAR blue     :LONGINT);

def vs.GetTileBackgroundColor(tileHandle):
    return (red, green, blue)

Parameters

tileHandle		HANDLE		The tile resource from which to get the background color.
red		LONGINT		Returns RGB color component value.
green		LONGINT		Returns RGB color component value.
blue		LONGINT		Returns RGB color component value.

Example

GetTileBackgroundColor(tileHandle, backgroundColor);

Version

Availability: from Vectorworks 2011

See Also

VS Functions:

VS:CreateTile | VS:ShowEditTileDialog | VS:ShowEditTileSettingsDialog | VS:ShowNewTileDialog | VS:GetTileGeometryGroup | VS:BeginGroupN | VS:AddTileGeometryObject | VS:GetTileGroupParent | VS:IsTileGroupContainedObject | VS:GetTileBackgroundColor | VS:SetTileBackgroundColor | VS:GetTileRepetitionPoint | VS:SetTileRepetitionPoint | VS:GetTileOffsetPoint | VS:SetTileOffsetPoint

VS Functions:

[[VS:CreateTile]] | [[VS:ShowEditTileDialog]] | [[VS:ShowEditTileSettingsDialog]] | [[VS:ShowNewTileDialog]] | [[VS:GetTileGeometryGroup]] | [[VS:BeginGroupN]] | [[VS:AddTileGeometryObject]] | [[VS:GetTileGroupParent]] | [[VS:IsTileGroupContainedObject]] | [[VS:GetTileBackgroundColor]] | [[VS:SetTileBackgroundColor]] | [[VS:GetTileRepetitionPoint]] | [[VS:SetTileRepetitionPoint]] | [[VS:GetTileOffsetPoint]]

| [[VS:SetTileOffsetPoint]]