如何用Python脚本在LibreOffice（Collabora Online）中插入用户域？

需要编写Python脚本，在LibreOffice（具体为Collabora Online）的文档中插入用户域。尝试两种方法均未解决：

• 录制实现操作的LibreOffice宏，改写为Python代码后无法运行；
• 找到功能相同的StarBasic脚本，但不知如何适配为Python实现。

录制的StarBasic宏代码 #

sub Main
rem ----------------------------------------------------------------------
rem define variables
dim document   as object
dim dispatcher as object
rem ----------------------------------------------------------------------
rem get access to the document
document   = ThisComponent.CurrentController.Frame
dispatcher = createUnoService("com.sun.star.frame.DispatchHelper")

rem ----------------------------------------------------------------------
dim args1(5) as new com.sun.star.beans.PropertyValue
args1(0).Name = "Type"
args1(0).Value = 20
args1(1).Name = "SubType"
args1(1).Value = 1
args1(2).Name = "Name"
args1(2).Value = "FIO"
args1(3).Name = "Content"
args1(3).Value = "FIO222"
args1(4).Name = "Format"
args1(4).Value = -1
args1(5).Name = "Separator"
args1(5).Value = " "

dispatcher.executeDispatch(document, ".uno:InsertField", "", 0, args1())
End sub

改写后无法运行的Python代码 #

import uno

def InsertLinkedImage():
    ctx = XSCRIPTCONTEXT.getComponentContext()
    smgr = ctx.ServiceManager
    oDisp = smgr.createInstanceWithContext(
        "com.sun.star.frame.DispatchHelper", ctx)
    oDoc = XSCRIPTCONTEXT.getDocument()
    oFrame = oDoc.getCurrentController().getFrame()
    props = (
        createProp("Type", 20),
        createProp("SubType", 1),
        createProp("Name", "FIO"),
        createProp("Content", "FIO222"),
        createProp("Format", -1),
        createProp("Separator", ""),
    )
    oDisp.executeDispatch(oFrame, ".uno:InsertField", "", 0, props)

def createProp(name, value):
    """Creates an UNO property."""
    prop = uno.createUnoStruct("com.sun.star.beans.PropertyValue")
    prop.Name = name
    prop.Value = value
    return prop

找到的功能正常的StarBasic参考代码 #

Sub InsertFieldIntoDocument(sFieldName As String, Optional bSection As Boolean, Optional bSectionOpened As Boolean)

    Dim oDoc As Object
    Dim oText As Object
    Dim oViewCursor As Object
    Dim oUserFieldMaster, oUserFieldMasters, oUserField As Object
    Dim bMasterExists As Boolean
    Dim sPrefix As String

    oDoc = ThisComponent
    oText = oDoc.getText()
    oViewCursor = oDoc.getCurrentController().getViewCursor()
   
    ' Handling optional values
    If IsMissing(bSection) Then bSection = False
    If IsMissing(bSectionOpened) Then bSectionOpened = False

    ' Getting the collection of masters of user fields
    oUserFieldMasters = oDoc.getTextFieldMasters()
    bMasterExists = False

    ' Checks is master field already exists
    sCalculatedFieldName = sFieldName
    ' If it's a section, we have to search for a specific field name
    If bSection Then
        If bSectionOpened Then
            sCalculatedFieldName = "SECT_" & sFieldName
        Else
            sCalculatedFieldName = "SECT_END_" & sFieldName
        End If
    End If
    If oUserFieldMasters.hasByName("com.sun.star.text.fieldmaster.User." & sCalculatedFieldName) Then
        bMasterExists = True
        oUserFieldMaster = oUserFieldMasters.getByName("com.sun.star.text.fieldmaster.User." & sCalculatedFieldName)
    End If

    ' Creates master field if it doesn't exist
    If Not bMasterExists Then
        oUserFieldMaster = oDoc.createInstance("com.sun.star.text.fieldmaster.User")
        oUserFieldMaster.Name = sCalculatedFieldName
        oUserFieldMaster.Content = ""
        Msgbox oUserFieldMaster.Value
    End If

    ' Creates the textfield that uses master
    oUserField = oDoc.createInstance("com.sun.star.text.textfield.User")
    oUserField.attachTextFieldMaster(oUserFieldMaster)

    ' Insert the field in the document
    oText.insertTextContent(oViewCursor, oUserField, False)

End Sub

适配后的Python实现代码 #

import uno

def InsertFieldIntoDocument(sFieldName, bSection=False, bSectionOpened=False):
    # 获取当前文档对象
    oDoc = XSCRIPTCONTEXT.getDocument()
    oText = oDoc.getText()
    oViewCursor = oDoc.getCurrentController().getViewCursor()

    # 处理section类型字段的名称前缀
    sCalculatedFieldName = sFieldName
    if bSection:
        sCalculatedFieldName = f"SECT_{sFieldName}" if bSectionOpened else f"SECT_END_{sFieldName}"
    
    # 获取用户域主字段集合，检查目标主字段是否已存在
    oUserFieldMasters = oDoc.getTextFieldMasters()
    master_full_name = f"com.sun.star.text.fieldmaster.User.{sCalculatedFieldName}"
    oUserFieldMaster = None
    
    if oUserFieldMasters.hasByName(master_full_name):
        oUserFieldMaster = oUserFieldMasters.getByName(master_full_name)
    else:
        # 不存在则创建新的用户域主字段
        oUserFieldMaster = oDoc.createInstance("com.sun.star.text.fieldmaster.User")
        oUserFieldMaster.Name = sCalculatedFieldName
        oUserFieldMaster.Content = ""  # 设置初始内容为空

    # 创建关联主字段的用户域文本字段
    oUserField = oDoc.createInstance("com.sun.star.text.textfield.User")
    oUserField.attachTextFieldMaster(oUserFieldMaster)

    # 在当前光标位置插入用户域
    oText.insertTextContent(oViewCursor, oUserField, False)

# 使用示例：插入名为"FIO"的普通用户域
# InsertFieldIntoDocument("FIO")

关键说明 #

• 直接调用LibreOffice UNO API，避免了DispatchHelper方式的参数适配问题；
• 完整保留原StarBasic代码的字段存在性检查、section类型字段处理逻辑；
• 需在LibreOffice/Collabora Online的Python宏环境中运行，依赖标准上下文对象XSCRIPTCONTEXT。

内容的提问来源于stack exchange，提问作者kireev20000