뷰어

주요 문서 뷰어 클래스

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

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

OpenDocumentAsync

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

OverloadUse when
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 — 발견된 라이선스가 거부됩니다(메시지에 거부 사유가 포함됨) 또는 형식에 더 이상 허용되지 않은 플러그인 기능이 필요합니다. 거부 메시지 없이 캘린더 만료 시 예외를 발생시키는 대신 워터마크가 적용된 렌더링으로 낮아집니다.
  • FormatNotSupportedExceptionDocument format '<extension>' is not supported.
    문서 형식 ''이 지원되지 않습니다.
  • InvalidDataException — 파일 내용이 손상되었거나 확장자와 일치하지 않습니다.

CloseDocument

text
void CloseDocument(string token)

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

GetPageCount

text
int GetPageCount(string token)

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

DocOptions

Per-open, format-independent options (namespace Doconut):

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

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

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

Custom watermark

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
    });
필드예시의미
Leading ^^선택적 모든 모서리 레이아웃. 없으면 일반 워터마크 배치가 사용됩니다.
TextConfidential각 페이지에 렌더링되는 텍스트. 비어 있어서는 안 됩니다.
ColorRed그리기 레이어가 이해하는 명명된 색상.
FontSize24글자 크기; 잘못된 숫자는 렌더러 기본값으로 대체됩니다.
FontNameVerdana요청된 글꼴 패밀리. 배포 환경에 설치되어 있는지 확인하세요.
Opacity800~255 사이의 바이트 값. 성공적으로 파싱되어야 합니다.
Angle-45회전 각도(도); 잘못된 숫자는 기본값으로 대체됩니다.

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

License decision → 라이선스 결정

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

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

Annotations API → 주석 API

서버 측 주석 로드 및 내보내기. 전체 안내는 가이드 → 주석에 있으며, 주요 인터페이스는 다음과 같습니다:

멤버목적
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 metadata → DICOM 메타데이터

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

DICOM 플러그인을 통해 연 세션에 대한 DICOM 태그 메타데이터를 반환합니다; 비 DICOM 문서는 null을 반환합니다.

Resource helpers — ReferenceCss / ReferenceScripts → 리소스 도우미 — 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 (검색 제한), IncludeAnnotationCss (주석 제한).

ScriptConfig 플래그: IncludeJQuery (다른 모든 플래그에 필요), IncludeBootstrap, IncludeViewerScripts (핵심: docViewer.js + splitter + links), IncludeSearchScriptsIncludeSearchBar (검색 제한), IncludeAnnotationScriptsIncludeAnnotationBar (주석 제한).

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 }))

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