Cài đặt trong .NET Standard / Core

Tệp Startup.cs

Trong tệp Startup.cs của một dự án .NET Core, các dòng mã này định nghĩa cấu hình pipeline middleware bằng phương thức MapWhen. Biểu thức được cung cấp kiểm tra xem đường dẫn yêu cầu có kết thúc bằng DocImage.axd hay không. Bên trong khối này, phương thức UseDoconut được gọi với một đối tượng DoconutOptions làm đối số.

Startup.cs
app.MapWhen(
    context => context.Request.Path.ToString().EndsWith("DocImage.axd"),
    appBranch =>
    {
        appBranch.UseDoconut(new DoconutOptions { UnSafeMode = false, ShowDoconutInfo = false });
    }
);

Thêm không gian tên Doconut

Trong dự án của bạn, thêm các câu lệnh using sau:

Usings
using Doconut;
using Doconut.Configs;
using Doconut.Formats;
using Doconut.Clouds;

Khởi tạo đối tượng Viewer

Dòng này khởi tạo một thể hiện mới của lớp Viewer, cho phép bạn tạo một đối tượng viewer trong code của mình.

Instantiation
var docViewer = new Viewer(_cache, _accessor, licenseFilePath);

Thiết lập đối tượng DocOptions

Ví dụ khởi tạo một đối tượng DocOptions với các cấu hình cụ thể:

DocOptions
var documentOptions = new DocOptions
{
    Password = "",
    ImageResolution = 200,
    TimeOut = 30
};

Thiết lập đối tượng config

Khởi tạo một đối tượng PdfConfig mới với các cấu hình để xử lý tài liệu PDF:

PdfConfig
var config = new PdfConfig { DefaultRender = true, ExtractHyperlinks = true };

Mở tài liệu của bạn

Dòng này gọi phương thức OpenDocument của đối tượng viewer, truyền đường dẫn tới tập tin tài liệu trên máy chủ và các đối tượng PdfConfig và DocOptions đã cấu hình trước làm tham số.

OpenDocument
var token = docViewer.OpenDocument(pathToFile, config, documentOptions);

Thêm viewer vào HTML của bạn

HTML
<div id="div_ctlDoc"></div>

Thêm các tập tin CSS và JavaScript

Thêm các tập tin CSS và JavaScript sau vào trang. Các script này được bao gồm trong tập ZIP có các mẫu mã.

HTML Headers
<link rel="stylesheet" href="css/viewer.css" />

<!-- Main Viewer Related Scripts -->
<script src="scripts/jquery.min.js"></script>
<script src="scripts/docViewer.js"></script>
<script src="scripts/splitter.js"></script>
<script src="scripts/search.js"></script>
<script src="scripts/documentLinks.js"></script>

<!-- Viewer functions -->
<script src="scripts/docViewer.UI.js?v=1"></script>

Thêm giấy phép vào dự án của bạn

Phát hiện giấy phép tự động

Để khởi tạo docViewer với phát hiện giấy phép tự động, sử dụng dòng sau:

C#
var docViewer = new Viewer(_cache, _accessor);

Thêm giấy phép mặc định chung

Bạn có thể chỉ định đường dẫn tới một tập tin giấy phép mặc định duy nhất khi khởi tạo viewer.

C#
var licenseFilePath = Path.Combine(_hostingEnvironment.WebRootPath, "path/to/your/license");
var docViewer = new Viewer(_cache, _accessor, licenseFilePath);

Thêm giấy phép bằng Stream

Phương thức này dùng overload Viewer.DoconutLicense(Stream licenseStream) để thêm giấy phép bằng một stream.

C#
using (var licenseStream = new FileStream("path/to/your/license", FileMode.Open))
{
    Viewer.DoconutLicense(licenseStream);
}

Thêm giấy phép bằng tài liệu XML

Phương thức này dùng overload Viewer.DoconutLicense(XMLDocument licence) để thêm giấy phép bằng một tài liệu XML.

C#
var xmlDoc = new XmlDocument();
xmlDoc.Load("path/to/your/license.xml");
Viewer.DoconutLicense(xmlDoc);

Nhiều giấy phép plugin mặc định chung

Nếu bạn cần chỉ định nhiều giấy phép, bạn có thể cung cấp danh sách các đường dẫn tập tin cho quá trình khởi tạo viewer.

C#
List<string> licenseFilePaths = new List<string>
{
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.lic"),
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.Annotation.lic"),
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.Search.lic")
};
var docViewer = new Viewer(_cache, _accessor, licenseFilePaths);

Thêm giấy phép plugin bằng Stream

Phương thức này dùng overload Viewer.SetLicensePlugin(Stream pluginLicence) để thêm giấy phép plugin bằng một stream.

C#
using (var pluginLicenseStream = new FileStream("path/to/your/plugin-license.lic", FileMode.Open))
{
    Viewer.SetLicensePlugin(pluginLicenseStream);
}

Thêm giấy phép plugin bằng tài liệu XML

Phương thức này dùng overload Viewer.SetLicensePlugin(XMLDocument xmlPluginLicence) để thêm giấy phép plugin bằng một tài liệu XML.

C#
var pluginXmlDoc = new XmlDocument();
pluginXmlDoc.Load("path/to/your/plugin-license.xml");
Viewer.SetLicensePlugin(pluginXmlDoc);

Các gói NuGet cần thiết

Để đảm bảo dự án của bạn hoàn toàn tương thích với .NET Core Standard, các gói NuGet sau cần được bao gồm, được liệt kê theo thứ tự alphabet.

  • MessagePack - Version 2.5.140
  • Microsoft.Bcl.AsyncInterfaces - Version 8.0.0
  • Microsoft.Extensions.Caching.Abstractions - Version 8.0.0
  • Microsoft.Extensions.Configuration - Version 8.0.0
  • Microsoft.Extensions.Configuration.Abstractions - Version 8.0.0
  • Microsoft.Extensions.Configuration.FileExtensions - Version 8.0.0
  • Microsoft.Extensions.Configuration.Json - Version 8.0.0
  • Microsoft.Extensions.FileProviders.Abstractions - Version 8.0.0
  • Microsoft.Extensions.FileProviders.Physical - Version 8.0.0
  • Microsoft.Extensions.FileSystemGlobbing - Version 8.0.0
  • Microsoft.Extensions.Primitives - Version 8.0.0
  • System.Buffers - Version 4.5.1
  • System.Formats.Asn1 - Version 8.0.0
  • System.Numerics.Vectors - Version 4.5.0
  • System.Security.Cryptography.Cng - Version 5.0.0
  • System.Security.Cryptography.Pkcs - Version 8.0.0
  • System.Text.Encoding.CodePages - Version 8.0.0
  • System.Text.Encodings.Web - Version 8.0.0
  • System.Text.Json - Version 8.0.3
  • System.Threading.Tasks.Extensions - Version 4.5.4

Tùy chọn cấu hình render

Bạn có thể cấu hình hành vi render bằng các tùy chọn sau:

  • CadConfig: Được sử dụng cho các tập tin DWG, DXF và DGN.
  • EmailConfig: Được sử dụng cho các tập tin EML, EMLX và MSG.
  • EpubConfig: Được sử dụng cho các tập tin EPUB.
  • ExcelConfig: Được sử dụng cho các tập tin Excel và CSV.
  • MhtConfig: Được sử dụng cho các tập tin MHT.
  • PptConfig: Được sử dụng cho các tập tin PowerPoint.
  • ProjectConfig: Được sử dụng cho các tập tin MPP.
  • PsdConfig: Được sử dụng cho các tập tin PSD.
  • TxtConfig: Được sử dụng cho các tập tin TXT.
  • TiffConfig: Được sử dụng cho các tập tin TIFF.

Cấu hình tùy chọn render

Các tùy chọn render được cấu hình bằng thuộc tính DefaultRender:

  • DefaultRender = true : Tùy chọn này cung cấp chất lượng render cao hơn nhưng tiêu tốn nhiều bộ nhớ máy chủ và thời gian xử lý hơn.
  • DefaultRender = false : Tùy chọn này cho phép render nhanh hơn nhưng chất lượng sẽ giảm một chút.

Cách thêm chú thích hình ảnh

Trong C#

1. Mở tài liệu và lấy kích thước của trang đầu tiên. 2. Khởi tạo AnnotationManager với kích thước trang. 3. Tạo một ImageAnnotation, đặt đường dẫn hình ảnh trong imgUrl, và chỉ định vị trí và kích thước trong Rectangle. 4. Thêm chú thích vào manager và tải nó trong document viewer để hiển thị.

C#
var token = docViewer.OpenDocument(pathToFile, config, documentOptions);

var firstPage = docViewer.GetThumbnailDimensions(1, 0, 100, false);
var pageWidth = firstPage.Width;
var pageHeight = firstPage.Height;

using (var annMgr = docViewer.GetAnnotationManager(pageWidth, pageHeight))
{
    string imgUrl = "img/sample.png";
    var imgAnn = new ImageAnnotation(
        1,
        new Rectangle(600, 700, 750, 300),
        imgUrl
    );

    annMgr.Add(imgAnn);
    docViewer.LoadAnnotationXML(annMgr.GetAnnotationXml());
}

Trong JavaScript

1. Đảm bảo YourController khả dụng. 2. Tạo một ImageAnnotation mới, đặt đường dẫn hình ảnh bằng SetNote. 3. Thêm và vẽ chú thích để render nó trên tài liệu.

JavaScript
function ImageStamp() {
    if (null != objctlDoc.YourController()) {
        var objStampImage = new ImageAnnotation({ left: 200, top: 200, width: 260, height: 55 });
        objctlDoc.YourController().AddAnnotation(null, objStampImage, null);

        objStampImage.SetNote('/images/Approved_Stamp.png');
        objStampImage.Paint();
    }
}

Phòng chữ tùy chỉnh trong tài liệu Word

Thuộc tính FontFolders trong lớp WordConfig chỉ định các thư mục tùy chỉnh mà ứng dụng sẽ tìm kiếm phông chữ. Điều này đặc biệt hữu ích cho việc xử lý tài liệu Word phụ thuộc vào các phông chữ không được cài đặt trong thư mục phông chữ mặc định của hệ thống.

Usage
var config = new WordConfig
{
    FontFolders = new string[] { "C:\\CustomFonts", "D:\\SharedFonts" }
};

Cập nhật quan trọng cho Doconut 25.2.0

Cần cập nhật gói System.Text.Json lên phiên bản 8.0.5 trong tất cả dự án của bạn. Cập nhật này là cần thiết để đảm bảo tương thích với các tính năng mới nhất và để khắc phục các cải tiến bảo mật quan trọng.

Mã hoá Email

Thuộc tính EmailEncoding trong lớp EmailConfig xác định bộ mã hoá ưu tiên cho cả tiêu đề và nội dung của email.

Usage
var emailConfig = new EmailConfig {
    EmailEncoding = Encoding.UTF8 // Set preferred email encoding
};

Mã hoá tiêu đề & nội dung

Các thuộc tính SubjectEncoding và BodyEncoding trong lớp EmailConfig định nghĩa bộ mã hoá được sử dụng cho tiêu đề và nội dung của email, tương ứng.

Usage
var emailConfig = new EmailConfig {
    SubjectEncoding = Encoding.UTF8, // Set encoding for the subject
    BodyEncoding = Encoding.UTF8     // Set encoding for the body
};

Hỗ trợ văn hoá cho Word Viewer

Thuộc tính DocumentCulture trong lớp WordConfig cho phép bạn xác định ngôn ngữ một cách rõ ràng cho các tệp DOC và DOCX. Điều này đảm bảo rằng nội dung được định dạng cục bộ—như ngày tháng, tiền tệ và số—hiển thị chính xác như trong Microsoft Word. Đặc biệt hữu ích cho các ngôn ngữ có yêu cầu định dạng riêng.

Usage
var config = new WordConfig { DocumentCulture = "he-IL" }; // Hebrew (Israel)
var config = new WordConfig { DocumentCulture = "ar-SA" }; // Arabic (Saudi Arabia)
var config = new WordConfig { DocumentCulture = "th-TH" }; // Thai (Thailand)
var config = new WordConfig { DocumentCulture = "ja-JP" }; // Japanese (Japan)

Đải tải các tập CSS và JS cần thiết

Để đảm bảo Doconut hoạt động đúng, bạn cần bao gồm các tập CSS và JS có thể trong dự án của mình. Bạn có thể tải xuống tập ZIP chứa tất cả các tập cần thiết bằng liên kết dưới đây:

Download Doconut JS and CSS Files