Skip to content

GetTileBackgroundColor.md

Latest commit

 

History

History
67 lines (56 loc) · 1.91 KB

GetTileBackgroundColor.md

File metadata and controls

67 lines (56 loc) · 1.91 KB
Raw

GetTileBackgroundColor

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

Name Type Description
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.

Examples

GetTileBackgroundColor(tileHandle, backgroundColor);
GetTileBackgroundColor(tileHandle, 1, 2, 3);
import vs

# Gets the specified tile resource's background color.
tileHandle = vs.FSActLayer()  # handle to the first selected object on the active layer

red, green, blue = vs.GetTileBackgroundColor(tileHandle)
vs.Message('GetTileBackgroundColor returned: ' + str((red, green, blue)))

See Also

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

Version

Availability: from Vectorworks 2011

Category