뷰어

주요 문서 뷰어 클래스

Viewer (namespace Doconut) 은 Razor 페이지, MVC 컨트롤러, Blazor 컴포넌트 또는 최소 API에서 문서를 열기 위한 공개 진입점입니다. sealed이며 AddDoconut()transient 서비스로 등록되고 생성자 주입을 통해 해결됩니다 — 직접 인스턴스를 만들지 마세요.

Viewer 는 요청당 상태를 보유하지 않으며 의도적으로 IDisposable 을 구현하지 않습니다: 문서 세션은 세션 캐시에서 독립적으로 존재하므로 서비스 해제 시 열린 문서가 해제될 수 없습니다(코어 개념 → Viewer 작동 방식 참조).

OpenDocumentAsync 메서드

문서를 열고 클라이언트 위젯이 이후 모든 요청에 사용할 세션 토큰을 반환합니다.

오버로드사용 상황
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default)자동 형식 감지와 해당 형식의 기본 구성을 사용하여 디스크에서 열 때
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default)형식별 렌더링 옵션(PdfConfig, WordConfig 등)이 필요할 때
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default)문서가 디스크에 파일이 아닐 때(업로드, 데이터베이스, 블롭). fileInfo 에 올바른 확장자를 포함해야 하며, 이것이 형식 감지를 담당합니다.
csharp
// Simple open
string token = await viewer.OpenDocumentAsync(path);

// With per-format config and options
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// From an upload
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

처리해야 할 예외:

  • LicenseException — 발견된 라이선스가 거부될 때(메시지에 거부 사유가 포함됨) 또는 형식에 더 이상 허용되지 않은 플러그인 기능이 필요할 때. 거부 메시지 없이 캘린더가 만료되면 예외를 발생시키는 대신 워터마크가 적용된 렌더링으로 낮아집니다.
  • FormatNotSupportedException — Document format '<extension>' is not supported.
  • InvalidDataException — 파일 내용이 손상되었거나 확장자와 일치하지 않을 때.

CloseDocument 메서드

text
void CloseDocument(string token)

세션을 캐시에서 제거하고(문서 엔진을 즉시 해제), 보안 마커를 삭제하며 접근 권한을 취소합니다. 선택 사항이지만 슬라이딩 만료도 동일한 정리를 수행하므로 대용량 문서에 권장됩니다.

GetPageCount 메서드

text
int GetPageCount(string token)

열린 세션의 전체 페이지 수를 반환합니다. 토큰이 알 수 없거나 만료된 경우 예외가 발생합니다.

DocOptions 클래스

열기 시점에 사용되는 형식에 독립적인 옵션 (namespace Doconut):

타입속성기본값설명
stringPassword""보호된 문서의 비밀번호(형식 구성에 자동으로 복사됨).
intImageResolution0Obsolete. 호환성을 위해만 유지 — 대신 형식 구성에서 ImageResolution을 설정하세요.
stringWatermark""렌더링된 페이지에 그려지는 사용자 지정 워터마크 텍스트. 형식 문자열: "^Text~Color~FontSize~FontName~Opacity~Angle", 예: "^Sample Copy~Red~24~Verdana~80~-45"
intTimeOut60세션 슬라이딩 만료(분).
boolIsSecuredtrue현재 적용되지 않음 — 예약된 옵션. 토큰 바인딩은 전역적으로 DoconutOptions.UnsafeMode에 의해 제어됩니다(코어 개념 → Sessions & Security).

클래스는 일반 단일 호스트 뷰잉 흐름 밖에서 의도적으로 제공되는 특수 속성도 포함합니다:

타입속성기본값설명
boolIsWebFarmfalse열기 작업을 웹 팜 시나리오로 표시합니다. 해당 공유 스토리지/세션 아키텍처와 함께 사용할 때만 사용하세요.
stringWebFarmPath""웹 팜 전용 워크플로우에서 사용하는 공유 경로. 일반 단일 호스트 뷰어에서는 비어 있습니다.
boolEditModefalse별도로 배포되는 Editor 워크플로우용 예약 옵션; 표준 뷰어에서는 false 로 두세요.

사용자 지정 워터마크

DocOptions.Watermark 은 6개의 틸드(~) 구분 필드를 사용합니다. 선택적 선행 ^ 는 모든 모서리 레이아웃을 요청합니다:

text
^Text~Color~FontSize~FontName~Opacity~Angle
csharp
string token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig(),
    new DocOptions
    {
        Watermark = "^Confidential~Red~24~Verdana~80~-45",
        TimeOut = 30
    });
필드예시의미
선행 ^^선택적 전체 코너 레이아웃. 없으면 일반 워터마크 배치가 사용됩니다.
TextConfidential각 페이지에 표시되는 텍스트. 비어 있으면 안 됩니다.
ColorRed그리기 레이어가 이해하는 색상 이름.
FontSize24글꼴 크기; 잘못된 숫자는 렌더러 기본값으로 대체됩니다.
FontNameVerdana요청된 글꼴 패밀리. 배포 환경에 설치되어 있어야 합니다.
Opacity800~255 사이의 바이트 값. 정상적으로 파싱되어야 합니다.
Angle-45회전 각도(도). 잘못된 숫자는 기본값으로 대체됩니다.

파서는 선택적 ^ 뒤에 정확히 여섯 개의 필드를 기대합니다. 정의가 잘못되면 SDK의 가시적인 Invalid Watermark 대체 텍스트가 사용되며, 조용히 사라지지는 않습니다.

라이선스 결정

라이선스 상태사용자 지정 값 제공 여부렌더링 결과
유효한 유료 뷰어 라이선스No깨끗한 페이지
유효한 유료 뷰어 라이선스Yes사용자 지정 워터마크
활성 임시/데모 기본 뷰어No깨끗한 기본 뷰어 페이지
활성 임시/데모 기본 뷰어Yes깨끗한 기본 뷰어 경로가 적용될 때 사용자 지정 워터마크
누락, 거부, 만료, 버전 불일치, 또는 잘못된 도메인 라이선스Either적용/평가 워터마크; 사용자 지정 값이 이를 대체하지 않음
플러그인 렌더링이 평가 규칙에 따라 진행 중Either평가 워터마크

동일한 결정이 제공되는 페이지 이미지와 주석 내보내기에 적용됩니다. 애니메이션 GIF 출력은 프레임마다 워터마크가 찍힙니다. 따라서 사용자 지정 워터마크는 평가 워터마크를 대체하거나 억제하는 것이 아니라, 라이선스가 있는 애플리케이션 기능입니다.

주석 API

서버 측 주석 로드 및 내보내기. 전체 가이드는 Guides → Annotations 에서 확인할 수 있습니다; 주요 인터페이스는 다음과 같습니다:

멤버목적
AnnotationManager GetAnnotationManager(string token)열려 있는 세션의 페이지 차원에 바인딩된 매니저
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight)명시적인 페이지 차원을 가진 매니저
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight)세션에 독립적인 매니저
void LoadAnnotationData(string token, AnnotationManager manager)C# 로 만든 주석을 세션에 로드
void LoadAnnotationData(string token, string annotationData)AnnotationManager.GetAnnotationData() 가 반환한 인코딩된 페이지/Base64 봉투에서 주석을 로드
void LoadAnnotationXML(string token, XmlDocument annotationXml)XML 에서 주석 로드
XmlDocument GetAnnotationXML(string token)세션의 주석을 XML 로 내보냄
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default)주석이 포함된 PDF
Task<int> ExportAnnotationsToPngAsync(…)주석이 포함된 PNG 파일
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default)주석이 포함된 페이지별 PNG 를 ZIP 으로 압축

DICOM 메타데이터

text
Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)

이 메서드는 API 정렬을 위해 존재하지만, .NET 6 DICOM 뷰어는 기술 태그를 제공할 수 없습니다. DICOM 및 비 DICOM 세션 모두 null 을 반환하며, DICOM 세션에서는 플랫폼 제한을 설명하는 일회성 경고가 기록됩니다. 페이지, 프레임 및 애니메이션 렌더링은 계속 지원됩니다.

리소스 도우미 — ReferenceCss / ReferenceScripts

UseDoconutResources() 로 제공되는 임베디드 리소스에 대한 <link>/<script> 태그를 올바른 의존 순서대로 출력합니다. 검색 및 주석과 같은 라이선스 제한 기능에 대한 번들은 라이선스가 활성화된 경우에만 출력되어 클라이언트 UI 가 서버 동작과 일치하도록 유지합니다.

text
string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)

CssConfig 플래그: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (search‑gated), IncludeAnnotationCss (annotation‑gated).

ScriptConfig 플래그: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScriptsIncludeSearchBar (search‑gated), IncludeAnnotationScriptsIncludeAnnotationBar (annotation‑gated).

html
@inject Doconut.Viewer Viewer

@Html.Raw(Viewer.ReferenceCss(new CssConfig { IncludeBootstrapCss = true, IncludeViewerCss = true }))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig { IncludeJQuery = true, IncludeViewerScripts = true }))

이 페이지가 도움이 되었나요?