Instalação

Instalação do SDK do Documentize

O Documentize pode ser instalado por meio de vários métodos, cada um adaptado a diferentes ambientes de desenvolvimento e preferências. Abaixo estão as maneiras recomendadas de instalar o Documentize:

1. NuGet (Método Preferido)

O NuGet é o método mais direto e preferido para instalar o Documentize, garantindo que você sempre tenha a versão mais recente e atualizações diretamente em seu ambiente de desenvolvimento. Confira mais detalhes sobre este método de instalação em Como instalar SDKs do Documentize usando NuGet.

2. Instalador MSI

O instalador MSI é uma opção conveniente se você preferir ter as DLLs do Documentize instaladas diretamente em seu sistema. Este método é ideal para desenvolvedores que desejam usar o Documentize em vários projetos sem precisar gerenciar manualmente os arquivos DLL. Confira mais detalhes sobre este método de instalação em Como instalar SDKs do Documentize usando MSI.

3. Arquivo ZIP

Para desenvolvedores que preferem uma abordagem manual, o arquivo ZIP contém as DLLs do Documentize, que podem ser extraídas e adicionadas ao seu projeto diretamente. Confira mais detalhes sobre este método de instalação em Como instalar SDKs do Documentize usando ZIP.

28 de dez. de 2024

Subsecções de Instalação

Instalando Documentize via NuGet

Dica

NuGet é um gerenciador de pacotes livre e de código aberto para .NET que simplifica a adição, remoção e atualização de bibliotecas em projetos do Visual Studio. Ele gerencia arquivos de biblioteca, referências e alterações de configuração automaticamente.

Como Instalar via Console do Gerenciador de Pacotes NuGet

  1. Abra Seu Projeto:

    • Inicie o Visual Studio e abra seu aplicativo .NET.

  2. Acesse o Console do Gerenciador de Pacotes:

    • Navegue em Ferramentas > Gerenciador de Pacotes NuGet > Console do Gerenciador de Pacotes.

  3. Instale o Pacote:

    • Para instalar a versão completa mais recente, insira o comando Install-Package Documentize.
    • Para instalar a versão mais recente, incluindo correções rápidas, use Install-Package Documentize -prerelease.
    • Pressione Enter para executar o comando.

Como Atualizar o Pacote via Console do Gerenciador de Pacotes NuGet

Se você já instalou o Documentize via NuGet e quer atualizar para a versão mais recente:

  1. Abra Seu Projeto:

    • Inicie o Visual Studio e abra seu aplicativo .NET.

  2. Acesse o Console do Gerenciador de Pacotes:

    • Navegue em Ferramentas > Gerenciador de Pacotes NuGet > Console do Gerenciador de Pacotes.

  3. Atualize o Pacote:

    • Para atualizar para a versão completa mais recente, insira Update-Package Documentize.
    • Para atualizar para a versão mais recente, incluindo correções rápidas, use Update-Package Documentize -prerelease.
    • Pressione Enter para executar o comando.

Como Instalar via GUI do Gerenciador de Pacotes NuGet

  1. Abra Seu Projeto:

    • Inicie o Visual Studio e abra seu aplicativo .NET.

  2. Navegue até Gerenciar Pacotes NuGet:

    • No menu Projeto, selecione Gerenciar Pacotes NuGet.

  3. Pesquise por Documentize:

    • Vá para a aba Procurar e insira Documentize no campo de busca.

  4. Instale o Pacote:

    • Clique em Instalar/Atualizar ao lado da versão mais recente do Documentize.
    • Confirme clicando em Aceitar na janela pop-up.

Prós de Usar o NuGet

  • Gerenciamento Automático de Dependências:

    • O NuGet gerencia automaticamente as dependências, garantindo que todas as bibliotecas necessárias estejam incluídas e atualizadas corretamente. Isso reduz o risco de faltar dependências ou de terem compatibilidades incorretas.

  • Atualizações Simplificadas:

    • Atualizar pacotes é direto com o NuGet, seja através do Console do Gerenciador de Pacotes ou GUI. Isso torna fácil manter suas bibliotecas atualizadas com os últimos recursos e correções de bugs.

  • Integrado com o Visual Studio:

    • O NuGet está perfeitamente integrado ao Visual Studio, proporcionando uma interface amigável para gerenciar pacotes sem sair do ambiente de desenvolvimento.

  • Versionamento:

    • O NuGet permite que você especifique e gerencie diferentes versões de bibliotecas, permitindo que você reverta facilmente para versões anteriores ou teste novas versões sem interromper seu desenvolvimento.

Contras de Usar o NuGet

  • Limitado ao Visual Studio:

    • O NuGet é projetado principalmente para uso dentro do Visual Studio. Embora possa ser usado em outros ambientes, a integração é mais robusta no Visual Studio.

  • Potencial para Conflitos de Versão:

    • Em projetos maiores com muitas dependências, gerenciar versões e resolver conflitos pode se tornar complexo. O NuGet fornece ferramentas para gerenciar isso, mas requer atenção cuidadosa.

  • Dependência de Rede:

    • Instalar e atualizar pacotes requer uma conexão com a internet. Se você estiver trabalhando em um ambiente com acesso à internet restrito ou inexistente, pode precisar usar métodos offline ou pré-baixar pacotes.

  • Complexidade para Projetos Grandes:

    • Para projetos muito grandes com árvores de dependência extensivas, a sobrecarga de gerenciar pacotes através do NuGet pode se tornar trabalhosa. Nesses casos, ferramentas ou estratégias adicionais podem ser necessárias para gerenciar dependências de forma eficaz.

Instalando Documentize via ZIP

Dica

O arquivo ZIP é ideal para desenvolvedores que preferem uma abordagem manual para gerenciar bibliotecas. Este método permite que você baixe e extraia diretamente os arquivos DLL necessários sem depender de um gerenciador de pacotes ou instalador.

Como Instalar via Arquivo ZIP

  1. Baixe o Arquivo ZIP:

    • Clique no v24.12 ZIP para baixar a versão mais recente do Documentize em formato de arquivo.

  2. Extraia o Conteúdo:

    • Após o download, extraia o conteúdo do arquivo ZIP para um diretório de sua escolha. Você pode optar por manter esses arquivos em um diretório compartilhado ou dentro da estrutura do seu projeto.

  3. Adicione Referências ao Seu Projeto:

    • Abra seu projeto em seu IDE (por exemplo, Visual Studio).
    • Vá para Projeto > Adicionar Referência > Procurar e navegue até o diretório onde você extraiu as DLLs.
    • Selecione os arquivos DLL relevantes e adicione-os como referências ao seu projeto.

  4. Atualizações Manuais:

    • Se uma nova versão do Documentize for lançada, você precisará baixar manualmente o arquivo ZIP atualizado e substituir os antigos arquivos DLL em seu projeto pelos novos.

Prós do Uso do Arquivo ZIP

  • Controle Completo:

    • Você tem controle total sobre onde e como as DLLs são armazenadas e referenciadas em seu projeto. Isso pode ser benéfico se você preferir uma configuração personalizada ou precisar gerenciar dependências manualmente.

  • Sem Dependência de Gerenciadores de Pacotes:

    • Diferente do NuGet, você não depende de um gerenciador de pacotes para lidar com instalações. Isso pode ser vantajoso em ambientes onde gerenciadores de pacotes não estão disponíveis ou não são preferidos.

  • Portabilidade:

    • O arquivo ZIP pode ser facilmente compartilhado e movido entre diferentes sistemas, tornando-o ideal para projetos que precisam ser portáteis ou distribuídos sem depender de ferramentas externas.

Contras do Uso do Arquivo ZIP

  • Gerenciamento Manual:

    • Diferente do NuGet, onde atualizações e gerenciamento de dependências são automatizados, com o arquivo ZIP, você deve gerenciar manualmente as atualizações e garantir que todas as DLLs necessárias estejam corretamente referenciadas.

  • Risco de Conflitos de Versão:

    • Se você está gerenciando vários projetos ou trabalhando em equipe, há um risco de conflitos de versão se projetos diferentes usarem versões diferentes das DLLs. Isso requer um rastreamento cuidadoso das versões entre os projetos.

  • Sem Atualizações Automáticas:

    • Você não receberá atualizações automáticas ou notificações quando uma nova versão estiver disponível. Isso pode levar ao risco de usar bibliotecas desatualizadas, a menos que você verifique regularmente se há atualizações.

Instalando o Documentize via MSI

Dica

O instalador MSI é uma opção conveniente e amigável para instalar o Documentize, particularmente se você preferir ter as DLLs instaladas globalmente no sistema. Este método simplifica o processo de instalação automatizando muitos dos passos envolvidos.

Como Instalar via Instalador MSI

  1. Baixe o Instalador MSI:

    • Clique no v24.12 MSI para baixar o instalador MSI para a versão mais recente do Documentize.

  2. Execute o Instalador:

    • Clique duas vezes no arquivo MSI baixado para iniciar o assistente de instalação.

  3. Siga o Assistente de Instalação:

    • Siga as instruções na tela fornecidas pelo instalador. Você poderá precisar concordar com o contrato de licença e selecionar opções de instalação.

  4. Finalize a Instalação:

    • Uma vez que a instalação esteja completa, as DLLs do Documentize serão instaladas no Cache de Assemblies Global (GAC) do seu sistema ou em outro local especificado.

  5. Verifique a Instalação:

    • Verifique se as DLLs estão corretamente instaladas verificando a presença delas no diretório de instalação designado ou no GAC.

Prós de Usar o Instalador MSI

  • Facilidade de Uso:

    • O instalador MSI proporciona um processo de instalação simples e guiado. Ele lida com todas as configurações necessárias e coloca as DLLs em um local central, facilitando o uso do Documentize em vários projetos.

  • Instalação Global:

    • O método MSI instala o Documentize no Cache de Assemblies Global (GAC) do sistema ou em outro local central. Isso permite que qualquer aplicação no sistema acesse as DLLs sem precisar referenciá-las individualmente em cada projeto.

  • Atualizações Automatizadas:

    • Se o Documentize fornecer um instalador atualizado, você pode facilmente atualizar sua instalação executando o novo arquivo MSI, que normalmente lida com o processo de atualização suavemente.

  • Consistência:

    • Usar o instalador MSI garante que todos os arquivos necessários sejam instalados corretamente e de forma consistente em diferentes ambientes, reduzindo o risco de DLLs ausentes ou mal posicionadas.

Contras de Usar o Instalador MSI

  • Flexibilidade Limitada:

    • O instalador MSI instala o Documentize em um local global do sistema, o que pode não ser adequado para todos os ambientes de desenvolvimento. Pode carecer da flexibilidade para acomodar configurações ou versões específicas de projeto.

  • Sobrecarga Potencial:

    • Instalar DLLs no GAC pode introduzir sobrecarga e complexidade, particularmente em cenários onde múltiplas versões do Documentize podem ser necessárias simultaneamente.

  • Remoção Manual:

    • Se você precisar desinstalar o Documentize, deve usar o desinstalador fornecido pelo MSI, que pode deixar arquivos residuais ou configurações se não for gerenciado corretamente.

  • Conflitos de Versão:

    • Instalações globais podem levar a conflitos de versão se diferentes projetos requerem diferentes versões do Documentize. Gerenciar esses conflitos pode exigir configuração ou limpeza adicional.

Ambiente Não-Windows

Trabalhando com DLLs .NET Core em Ambiente Não-Windows

Como o Documentize para .NET oferece suporte ao .NET Standard 2.0 (.NET Core 2.0), ele pode ser usado em Aplicativos Core que executam em sistemas operacionais semelhantes ao Linux. Estamos constantemente trabalhando para melhorar o suporte ao .NET Core em nossa API. No entanto, há algumas operações que recomendamos que nossos clientes realizem para obter melhores resultados ao usar recursos do Documentize para .NET. Por favor, instale:

  • pacote libgdiplus
  • Pacote com fontes compatíveis com Microsoft: ttf-mscorefonts-installer (por exemplo, sudo apt-get install ttf-mscorefonts-installer). Essas fontes devem ser colocadas no diretório /usr/share/fonts/truetype/msttcorefonts, pois o Documentize para .NET verifica esta pasta em sistemas operacionais semelhantes ao Linux. Caso o sistema operacional tenha outra pasta/diretório padrão para fontes, você deve usar a seguinte linha de código antes de realizar qualquer operação usando o Documentize:
    Documentize.Pdf.Text.FontRepository.Sources.Add(new FolderFontSource("<caminho do usuário para fontes ms>"));
 Português