summaryrefslogtreecommitdiff
path: root/scripting/examples/python/SetCellColor.py
blob: 4229d9914f6a7e4be92970c2ce2f18ae9781bb03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#
# This file is part of the LibreOffice project.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This file incorporates work covered by the following license notice:
#
#   Licensed to the Apache Software Foundation (ASF) under one or more
#   contributor license agreements. See the NOTICE file distributed
#   with this work for additional information regarding copyright
#   ownership. The ASF licenses this file to you under the Apache
#   License, Version 2.0 (the "License"); you may not use this file
#   except in compliance with the License. You may obtain a copy of
#   the License at http://www.apache.org/licenses/LICENSE-2.0 .
#

def SetCellColor(x, y, color):
    """Sets the background of the cell at (x,y) (zero-based column and row
       indices, for example (2,3) == C4) on the first sheet and
       returns the contents of the cell as a string.
    """
    # Get the doc from the scripting context which is made available to
    # all scripts.
    desktop = XSCRIPTCONTEXT.getDesktop()
    model = desktop.getCurrentComponent()

    # Check whether there's already an opened document.
    if not hasattr(model, "Sheets"):
        return ""

    sheet = model.Sheets.Sheet1
    cell = sheet.getCellByPosition(x, y)

    cell.CellBackColor = color

    return cell.String