Usando tags de documentos estruturados (SDT) em Aspose.Words para Java

Introdução ao uso de tags de documentos estruturados (SDT) em Aspose.Words para Java

Tags de documentos estruturados (SDT) são um recurso poderoso do Aspose.Words for Java que permite criar e manipular conteúdo estruturado em seus documentos. Neste guia abrangente, orientaremos você nos vários aspectos do uso de SDTs no Aspose.Words for Java. Quer você seja um desenvolvedor iniciante ou experiente, encontrará informações valiosas e exemplos práticos neste artigo.

Começando

Antes de nos aprofundarmos nos detalhes, vamos configurar nosso ambiente e criar um SDT básico. Nesta seção, abordaremos os seguintes tópicos:

Criando um novo documento
Adicionando uma tag de documento estruturado
Salvando o documento

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Crie uma tag de documento estruturado do tipo CHECKBOX
StructuredDocumentTag sdtCheckBox = new StructuredDocumentTag(doc, SdtType.CHECKBOX, MarkupLevel.INLINE);
builder.insertNode(sdtCheckBox);

// Salve o documento
doc.save("WorkingWithSDT.docx");

Verificando o estado atual de uma caixa de seleção SDT

Depois de adicionar uma caixa de seleção SDT ao seu documento, você pode querer verificar seu estado atual programaticamente. Isto pode ser útil quando você precisa validar a entrada do usuário ou executar ações específicas com base no estado da caixa de seleção.

Document doc = new Document("WorkingWithSDT.docx");
StructuredDocumentTag sdtCheckBox = (StructuredDocumentTag) doc.getChild(NodeType.STRUCTURED_DOCUMENT_TAG, 0, true);

if (sdtCheckBox.getSdtType() == SdtType.CHECKBOX) {
    // A caixa de seleção está marcada
    sdtCheckBox.setChecked(true);
}

doc.save("UpdatedDocument.docx");

Modificando controles de conteúdo

Nesta seção, exploraremos como modificar os controles de conteúdo em seu documento. Abordaremos três tipos de controles de conteúdo: texto simples, lista suspensa e imagem.

Modificando o controle de conteúdo de texto simples

Document doc = new Document("WorkingWithSDT.docx");
StructuredDocumentTag sdtPlainText = (StructuredDocumentTag) doc.getChild(NodeType.STRUCTURED_DOCUMENT_TAG, 0, true);

if (sdtPlainText.getSdtType() == SdtType.PLAIN_TEXT) {
    // Limpe o conteúdo existente
    sdtPlainText.removeAllChildren();

    // Adicionar novo texto
    Paragraph para = (Paragraph) sdtPlainText.appendChild(new Paragraph(doc));
    Run run = new Run(doc, "New text goes here");
    para.appendChild(run);
}

doc.save("ModifiedDocument.docx");

Modificando o controle de conteúdo da lista suspensa

Document doc = new Document("WorkingWithSDT.docx");
StructuredDocumentTag sdtDropDown = (StructuredDocumentTag) doc.getChild(NodeType.STRUCTURED_DOCUMENT_TAG, 0, true);

if (sdtDropDown.getSdtType() == SdtType.DROP_DOWN_LIST) {
    // Selecione o segundo item da lista
    SdtListItem secondItem = sdtDropDown.getListItems().get(2);
    sdtDropDown.getListItems().setSelectedValue(secondItem);
}

doc.save("ModifiedDocument.docx");

Modificando o controle de conteúdo de imagem

Document doc = new Document("WorkingWithSDT.docx");
StructuredDocumentTag sdtPicture = (StructuredDocumentTag) doc.getChild(NodeType.STRUCTURED_DOCUMENT_TAG, 0, true);
Shape shape = (Shape) sdtPicture.getChild(NodeType.SHAPE, 0, true);

if (shape.hasImage()) {
    // Substitua a imagem por uma nova
    shape.getImageData().setImage("Watermark.png");
}

doc.save("ModifiedDocument.docx");

Criando um controle de conteúdo ComboBox

Um controle de conteúdo ComboBox permite que os usuários selecionem em uma lista predefinida de opções. Vamos criar um em nosso documento.

Document doc = new Document();
StructuredDocumentTag sdtComboBox = new StructuredDocumentTag(doc, SdtType.COMBO_BOX, MarkupLevel.BLOCK);
sdtComboBox.getListItems().add(new SdtListItem("Choose an item", "-1"));
sdtComboBox.getListItems().add(new SdtListItem("Item 1", "1"));
sdtComboBox.getListItems().add(new SdtListItem("Item 2", "2"));
doc.getFirstSection().getBody().appendChild(sdtComboBox);

doc.save("ComboBoxDocument.docx");

Trabalhando com controle de conteúdo Rich Text

Os controles de conteúdo Rich Text são perfeitos para adicionar texto formatado aos seus documentos. Vamos criar um e definir seu conteúdo.

Document doc = new Document();
StructuredDocumentTag sdtRichText = new StructuredDocumentTag(doc, SdtType.RICH_TEXT, MarkupLevel.BLOCK);
Paragraph para = new Paragraph(doc);
Run run = new Run(doc);
run.setText("Hello World");
run.getFont().setColor(Color.GREEN);
para.getRuns().add(run);
sdtRichText.getChildNodes().add(para);
doc.getFirstSection().getBody().appendChild(sdtRichText);

doc.save("RichTextDocument.docx");

Configurando estilos de controle de conteúdo

Você pode aplicar estilos aos controles de conteúdo para aprimorar a aparência visual do seu documento. Vamos ver como definir o estilo de um controle de conteúdo.

Document doc = new Document("WorkingWithSDT.docx");
StructuredDocumentTag sdt = (StructuredDocumentTag) doc.getChild(NodeType.STRUCTURED_DOCUMENT_TAG, 0, true);

//Aplicar um estilo personalizado
Style style = doc.getStyles().getByStyleIdentifier(StyleIdentifier.QUOTE);
sdt.setStyle(style);

doc.save("StyledDocument.docx");

Vinculando um SDT a dados XML personalizados

Em alguns cenários, pode ser necessário vincular um SDT a dados XML personalizados para geração de conteúdo dinâmico. Vamos explorar como conseguir isso.

Document doc = new Document();
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(UUID.randomUUID().toString(), "<root><text>Hello, World!</text></root>");
StructuredDocumentTag sdt = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.BLOCK);
doc.getFirstSection().getBody().appendChild(sdt);
sdt.getXmlMapping().setMapping(xmlPart, "/root[1]/text[1]", "");

doc.save("CustomXMLBinding.docx");

Criando uma tabela com seções repetidas mapeadas para dados XML personalizados

Tabelas com seções repetidas podem ser extremamente úteis para apresentar dados estruturados. Vamos criar essa tabela e mapeá-la para dados XML personalizados.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
CustomXmlPart xmlPart = doc.getCustomXmlParts().add("Books", "<books>...</books>");
Table table = builder.startTable();
builder.insertCell();
builder.write("Title");
builder.insertCell();
builder.write("Author");
builder.endRow();
builder.endTable();

StructuredDocumentTag repeatingSectionSdt = new StructuredDocumentTag(doc, SdtType.REPEATING_SECTION, MarkupLevel.ROW);
repeatingSectionSdt.getXmlMapping().setMapping(xmlPart, "/books[1]/book", "");
table.appendChild(repeatingSectionSdt);

StructuredDocumentTag repeatingSectionItemSdt = new StructuredDocumentTag(doc, SdtType.REPEATING_SECTION_ITEM, MarkupLevel.ROW);
repeatingSectionSdt.appendChild(repeatingSectionItemSdt);

Row row = new Row(doc);
repeatingSectionItemSdt.appendChild(row);

StructuredDocumentTag titleSdt = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.CELL);
titleSdt.getXmlMapping().setMapping(xmlPart, "/books[1]/book[1]/title[1]", "");
row.appendChild(titleSdt);

StructuredDocumentTag authorSdt = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.CELL);
authorSdt.getXmlMapping().setMapping(xmlPart, "/books[1]/book[1]/author[1]", "");
row.appendChild(authorSdt);

doc.save("RepeatingTableDocument.docx");

Trabalhando com tags de documentos estruturados de múltiplas seções

Tags de documentos estruturados podem abranger várias seções de um documento. Nesta seção, exploraremos como trabalhar com SDTs de múltiplas seções.

Document doc = new Document("MultiSectionDocument.docx");
NodeCollection tags = doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG_RANGE_START, true);

for (StructuredDocumentTagRangeStart tag : tags) {
    System.out.println(tag.getTitle());
}

doc.save("ModifiedMultiSectionDocument.docx");

Conclusão

Tags de documentos estruturados em Aspose.Words for Java fornecem uma maneira versátil de gerenciar e formatar conteúdo em seus documentos. Se você precisa criar modelos, formulários ou documentos dinâmicos, os SDTs oferecem a flexibilidade e o controle necessários. Seguindo os exemplos e diretrizes fornecidos neste artigo, você pode aproveitar o poder dos SDTs para aprimorar suas tarefas de processamento de documentos.

Perguntas frequentes

Qual é a finalidade das tags de documentos estruturados (SDTs)?

Tags de documentos estruturados (SDTs) têm a finalidade de organizar e formatar o conteúdo dos documentos, facilitando a criação de modelos, formulários e documentos estruturados.

Como posso verificar o estado atual de um Checkbox SDT?

Você pode verificar o estado atual de um Checkbox SDT usando osetChecked método, conforme demonstrado no artigo.

Posso aplicar estilos aos controles de conteúdo?

Sim, você pode aplicar estilos aos controles de conteúdo para personalizar sua aparência no documento.

É possível vincular um SDT a dados XML personalizados?

Sim, você pode vincular um SDT a dados XML personalizados, permitindo geração de conteúdo dinâmico e mapeamento de dados.

O que são seções repetidas em SDTs?

A repetição de seções em SDTs permite criar tabelas com dados dinâmicos, onde as linhas podem ser repetidas com base nos dados XML mapeados.

Usando intervalos de documentos em Aspose.Words para Java Usando estilos e temas em Aspose.Words para Java