Serviço SFDocuments.Document

A biblioteca SFDocuments fornece métodos e propriedades que facilitam a gestão e manuseio de documentos do LibreOffice.

Métodos aplicáveis a todos os tipos de documentos (documentos de texto, planilhas, apresentações, etc.) são disponibilizados pelo serviço SFDocuments.Document. Alguns exemplos são:

warning

As propriedades, métodos ou argumentos marcados com (*) NÃO são aplicáveis a documentos Base.


Métodos e propriedades que são específicos a componentes específicos do LibreOffice são disponibilizados em serviços separados, tais como SFDocuments.SF_Calc e SFDocuments.SF_Base.

Apesar de a linguagem Basic não oferecer herança entre classes de objeto, os serviços específicos podem ser considerados como subclasses do serviço SFDocuments.Document. Tais subclasses também podem chamar os métodos e propriedades descritos abaixo.

Invocação do serviço

Abaixo são apresentadas três variantes de como invocar o serviço Document.

Em Basic

Usando o método getDocument do serviço ScriptForge.UI:


    Dim ui As Object, oDoc As Object
    Set ui = CreateScriptService("UI")
    Set oDoc = ui.GetDocument("Untitled 1")
  

Alternativamente você pode usar os métodos CreateDocument e OpenDocument do serviço UI.


    Set oDocA = ui.CreateDocument("Calc")
    Set oDocB = ui.OpenDocument("C:\Documents\MyFile.odt")
  

Diretamente se o documento já estiver aberto.


    Dim oDoc As Object
    Set oDoc = CreateScriptService("SFDocuments.Document", "Untitled 1") 'Default = ActiveWindow
  

A partir de uma macro disparada por um evento de documento.


    Sub RunEvent(ByRef poEvent As Object)
        Dim oDoc As Object
        Set oDoc = CreateScriptService("SFDocuments.DocumentEvent", poEvent)
        ' (...)
    End Sub
  
note

O serviço Document está intimamente relacionado aos serviços UI e FileSystem.


Com exceção de quando o documento for fechado pela macro com o método CloseDocument (seria redundante liberar recursos), recomenda-se liberar os recursos usando:


    Set oDoc = oDoc.Dispose()
  
Em Python

    from scriptforge import CreateScriptService
    ui = CreateScriptService("UI")
    doc = ui.GetDocument("Untitled 1")
    # (...)
    doc.Dispose()
  

    docA = ui.CreateDocument("Calc")
    docB = ui.OpenDocument("C:\Documents\MyFile.odt")
  

    doc = CreateScriptService("SFDocuments.Document", "Untitled 1")
  

    def RunEvent(event)
        doc = CreateScriptService("SFDocuments.DocumentEvent", Event)
        # (...)
  
tip

O uso do prefixo "SFDocuments." ao chamar o serviço é opcional.


Propriedades

Nome

Somente leitura

Tipo

Descrição

CustomProperties (*)

Não

Dictionary service

Retorna um objeto ScriptForge.Dictionary. Após a atualização, pode ser passado novamente para a propriedade para atualizar o documento.
Itens individuais do dicionário podem ser strings, números, datas (Basic) ou itens com.sun.star.util.Duration.

Description (*)

Não

String

Fornece acesso à propriedade "Description" do documento (também conhecida como "Comments")

DocumentProperties (*)

Sim

Dictionary service

Retorna um objeto ScriptForge.Dictionary contendo todas as entradas. Estatísticas do documento também estão inclusas. Note que os itens do dicionário dependem do tipo do documento. Por exemplo, um documento Calc inclui uma entrada "CellCount", ao passo que outros tipos de documento não têm essa entrada.

DocumentType

Sim

String

Valor string com o tipo do documento ("Base", "Calc", "Writer", etc)

IsBase
IsCalc
IsDraw
IsImpress
IsMath
IsWriter

Sim

Boolean

Exatamente uma destas propriedades é True para um dado documento.

Keywords (*)

Não

String

Fornece acesso à propriedade "Keywords" do documento, a qual é representada como uma lista separada por vírgulas.

Readonly (*)

Sim

Boolean

True se o documento estiver no modo somente leitura.

Subject (*)

Não

String

Fornece acesso à propriedade "Subject" do documento.

Title (*)

Não

String

Fornece acesso à propriedade "Title" do documento.

XComponent

Sim

Objeto UNO

O objeto UNO com.sun.star.lang.XComponent ou com.sun.star.comp.dba.ODatabaseDocument representando o documento


Exemplo:

Em Basic

O exemplo abaixo imprime todas as propriedades de um documento. Note que o objeto oDoc retornado pelo método UI.OpenDocument é um objeto SFDocuments.Document.


    Dim ui as Variant : Set ui = CreateScriptService("UI")
    Dim oDoc as Object
    Set oDoc = ui.OpenDocument("C:\Documents\MyFile.ods")
    Dim propDict as Object
    Set propDict = oDoc.DocumentProperties
    Dim keys as Variant : propKeys = propDict.Keys
    Dim k as String, strProp as String
    For Each k In propKeys
        strProp = strProp & k & ": " & propDict.Item(k) & CHR$(10)
    Next k
    MsgBox strProp
    oDoc.CloseDocument()
  
Em Python

Para acessar as propriedades de documento em um script Python o usuário deve acessá-los diretamente usando seus nomes, como mostrado abaixo:


    doc = ui.GetDocument(r"C:\Documents\MyFile.ods")
    msg = doc.Title + '\n' + doc.Description + '\n' + doc.Keywords
    bas = CreateScriptService("Basic")
    bas.MsgBox(msg)
    doc.CloseDocument()
  

Lista de Métodos do Serviço Document

Activate
CloseDocument
ExportAsPDF

PrintOut
RunCommand
Save

SaveAs
SaveCopyAs
SetPrinter


Activate

Retorna True se o documento foi efetivamente ativado. Senão, não há mudança na interface de usuário. É equivalente ao método Activate do serviço UI.

Este método é útil quando se precisa dar foco a um documento que está minimizado ou oculto.

Sintaxe:

svc.Activate(): bool

Exemplo:

O exemplo abaixo considera que "My_File.ods" já está aberto, porém não está ativo.

Em Basic

    Dim oDoc As Object
    Set oDoc = CreateScriptService("Document", "MyFile.ods")
    oDoc.Activate()
  
Em Python

    doc = CreateScriptService("Document", "MyFile.ods")
    doc.Activate()
  
tip

Lembre-se que você pode chamar o serviço Document passando tanto a string "Document" como a string "SFDocuments.Document" para o método CreateScriptService


CloseDocument

Fecha o documento. Se o documento estiver fechado, independentemente de como ele foi fechado, este método não tem efeito e retorna False.

Este método também retornará False se o usuário se recusar a fechá-lo.

Retorna True se o fechamento do arquivo foi bem-sucedido.

Sintaxe:

svc.CloseDocument(saveask: bool = True): bool

Parâmetros:

saveask: Se for True (padrão), o usuário é convidado a confirmar se as mudanças devem ser salvas no disco. Este argumento é ignorado se o documento não foi modificado.

Exemplo:

Em Basic

    If oDoc.CloseDocument(True) Then
        ' ...
    End If
  
Em Python

    if doc.CloseDocument(True):
        # ...
  

ExportAsPDF

Exports the document directly as a PDF file to the specified location. Returns True if the PDF file was successfully created.

The export options can be set either manually using the File - Export As - Export as PDF dialog or by calling the methods GetPDFExportOptions and SetPDFExportOptions from the Session service.

Sintaxe:

svc.ExportAsPDF(filename: str, overwrite: bool = False, opt pages: str, opt password: str, opt watermark: str): bool

Parâmetros:

filename: The full path and file name of the PDF to be created. It must follow the SF_FileSystem.FileNaming notation.

overwrite: Specifies if the destination file can be overwritten (Default = False). An error will occur if overwrite is set to False and the destination file already exists.

pages: String specifying which pages will be exported. This argument uses the same notation as in the dialog File - Export As - Export as PDF.

password: Specifies a password to open the PDF file.

watermark: Text to be used as watermark in the PDF file, which will be drawn in every page of the resulting PDF.

Exemplo:

Em Basic

The following example exports the current document as a PDF file, defines a password and overwrites the destination file if it already exists.


    oDoc.ExportAsPDF("C:\User\Documents\myFile.pdf", Password := "1234", Overwrite := True)
  

The code snippet below gets the current PDF export options and uses them to create the PDF file.


    Dim exportSettings as Object, oSession as Object
    oSession = CreateScriptService("Session")
    exportSettings = oSession.GetPDFExportOptions()
    ' Sets to True the option to export comments as PDF notes
    exportSettings.ReplaceItem("ExportNotes", True)
    oSession.SetPDFExportOptions(exportSettings)
    oDoc.ExportAsPDF("C:\User\Documents\myFile.pdf")
  
Em Python

    doc.ExportAsPDF(r"C:\User\Documents\myFile.pdf", password = "1234", overwrite = True)
  

    session = CreateScriptService("Session")
    exportSettings = oSession.GetPDFExportOptions()
    exportSettings.ReplaceItem("ExportNotes", True)
    session.SetPDFExportOptions(exportSettings)
    doc.ExportAsPDF(r"C:\User\Documents\myFile.pdf")
  

PrintOut

This method sends the contents of the document to the default printer or to the printer defined by the SetPrinter method.

Retorna True se a impressão do documento foi bem-sucedida.

Sintaxe:

svc.PrintOut(pages: str = "", copies: num = 1): bool

Parâmetros:

pages: String contendo as páginas a serem impressas, da mesma forma como é feita a definição usando a interface do usuário. Por exemplo: "1-4;10;15-18". O valor padrão é a impressão de todas as páginas.

copies: The number of copies. Default is 1.

Exemplo:

Em Basic

    If oDoc.PrintOut("1-4;10;15-18", Copies := 2) Then
        ' ...
    End If
  
Em Python

    if doc.PrintOut(copies=3, pages='45-88'):
        # ...
  

RunCommand

Executa um comando em um documento. O comando é executado sem argumentos.

Alguns comandos típicos são: Save, SaveAs, ExportToPDF, SetDocumentProperties, Undo, Copy, Paste, etc. Os nomes estão em inglês pois correspondem aos nomes usados na API do LibreOffice.

O documento em si não precisa estar ativo para ser possível executar comandos.

Sintaxe:

svc.RunCommand(command: str)

Parâmetros:

command: String sensível ao caso contendo o comando em inglês. O comando não é verificado como sendo correto antes da execução. Se nada acontecer após a chamada do comando, então provavelmente o comando está errado.

Exemplo:

O exemplo a seguir executa o comando "SelectData" em um arquivo Calc chamado "MyFile.ods", resultando na seleção da área de dados com base na célula selecionada no momento.

Em Basic

    Set oDoc = CreateScriptService("Document", "MyFile.ods")
    oDoc.RunCommand("SelectData")
  
Em Python

    doc = CreateScriptService("Document", "MyFile.ods")
    doc.RunCommand("SelectData")
  

The example above actually runs the UNO command .uno:SelectData. Hence, to use the RunCommand method it is necessary to remove the ".uno:" substring.

tip

Cada aplicação do LibreOffice possui seu conjunto próprio de comandos UNO disponíveis. Uma forma fácil de aprender os comandos é abrindo Ferramentas > Personalizar > Teclado. Se você posicionar o mouse em uma função na lista Função, uma dica será apresentada com o comando UNO correspondente.


Save

Armazena o documento no arquivo e localização de onde ele foi carregado. O método é ignorado se o documento não foi modificado.

Retorna False se o documento não pode ser salvo. Um erro é lançado se o arquivo estiver aberto como somente leitura ou se for um arquivo novo que ainda não foi salvo.

O documento em si não precisa estar ativo para executar este método.

Sintaxe:

svc.Save(): bool

Exemplo:

Em Basic

    If Not oDoc.Save() Then
        ' ...
    End If
  
Em Python

    if not doc.Save():
        # ...
  

SaveAs

Armazena o documento em um arquivo e localização especificado. O novo nome de arquivo é usado quando chamadas subsequentes do método Save forem realizadas.

Retorna False se o documento não pode ser salvo. Um erro é lançado se o usuário rejeitar sobrescrever o arquivo ou quando o atributo "somente leitura" estiver ativo no arquivo de destino.

O documento em si não precisa estar ativo para executar este método.

Sintaxe:

svc.SaveAs(filename: str, overwrite: bool = False, password: str = '', filtername: str = '', filteroptions: str = ''): bool

Parâmetros:

filename: String contendo o nome do arquivo a ser usado. Deve seguir a notação SF_FileSystem.FileNaming.

overwrite: Se for True, o arquivo de destino pode ser sobrescrito (padrão = False).

password (*): String sem espaços com a senha usada para proteger o documento.

filtername (*): Nome do filtro que deve ser usado para salvar o documento. Se este argumento for passado, então o filtro deve existir.

filteroptions (*): Uma string opcional com as opções associadas ao filtro.

Exemplo:

Em Basic

    oDoc.SaveAs("C:\Documents\NewCopy.odt", overwrite := True)
  
Em Python

    doc.SaveAs(r"C:\Documents\NewCopy.odt", overwrite = True)
  

SaveCopyAs

Armazena uma cópia ou exporta o documento para um arquivo e localização especificado. O arquivo atual não é modificado.

Retorna False se o documento não pode ser salvo. Um erro é lançado se o usuário rejeitar sobrescrever o arquivo ou quando o atributo "somente leitura" estiver ativo no arquivo de destino.

O documento em si não precisa estar ativo para executar este método.

Sintaxe:

svc.SaveCopyAs(filename: str, overwrite: bool = False, password: str = '', filtername: str = '', filteroptions: str = ''): bool

Parâmetros:

filename: String contendo o nome do arquivo a ser usado. Deve seguir a notação SF_FileSystem.FileNaming.

overwrite: Se for True, o arquivo de destino pode ser sobrescrito (padrão = False).

password (*): String sem espaços com a senha usada para proteger o documento.

filtername (*): Nome do filtro que deve ser usado para salvar o documento. Se este argumento for passado, então o filtro deve existir.

filteroptions (*): Uma string opcional com as opções associadas ao filtro.

Exemplo:

Em Basic

    oDoc.SaveCopyAs("C:\Documents\Copy2.odt", Overwrite := True)
  
Em Python

    doc.SaveCopyAs(r"C:\Documents\Copy2.odt", overwrite = True)
  

SetPrinter

Define as opções de impressão para o documento.

Retorna True se bem-sucedida.

Sintaxe:

svc.SetPrinter(opt printer: str, opt orientation: str, paperformat: str): bool

Parâmetros:

printer: Nome da fila de impressão para a qual a impressão será enviada. Se ausente, a impressora padrão é usada.

orientation: Pode ser PORTRAIT ou LANDSCAPE. Se ausente, a orientação não é alterada e o valor definido nas configurações da impressora será usado.

paperformat: Specifies the paper format as a string value that can be either A3, A4, A5, LETTER, LEGAL or TABLOID. Left unchanged when absent.

Exemplo:

Em Basic

    oDoc.SetPrinter(Orientation := "PORTRAIT")
  
Em Python

    doc.SetPrinter(paperformat='TABLOID')
  
warning

Todas as rotinas ou identificadores do ScriptForge em Basic que possuem o caractere "_" como prefixo são reservadas para uso interno. Elas não devem ser usadas em macros escritas em Basic ou em Python.