stamper.h

Go to the documentation of this file.

// Copyright (c) 2009-2026 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_STAMPER_H_INCLUDED_
#define PDFSDK_STAMPER_H_INCLUDED_

 
#include <pdfsdk/core.h>
#include <pdfsdk/graphics.h>
 
#ifdef PDF_STAMPER_EXPORTS
#define PDF_STAMPER_API PDFSDK_EXPORT_
#else
#define PDF_STAMPER_API PDFSDK_IMPORT_
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    kPDFStampSizeRelative = 1,
    kPDFStampSizeAbsolute = 2,
    kPDFStampSizeFontSize = 3
} PDFStampSizeMode;

typedef enum {
    kPDFStampHAlignLeft = -1,
    kPDFStampHAlignCenter = 0,
    kPDFStampHAlignRight = 1
} PDFStampHAlign;

typedef enum {
    kPDFStampVAlignBottom = -1,
    kPDFStampVAlignCenter = 0,
    kPDFStampVAlignTop = 1
} PDFStampVAlign;

typedef enum {
    kPDFStampTextAlignLeft = -1,
    kPDFStampTextAlignCenter = 0,
    kPDFStampTextAlignRight = 1
} PDFStampTextAlign;

typedef struct PDFStamperRec_* PDFStamper;

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperCreate(PDFStampSizeMode sizeMode, float a, float b, PDFStamper* pStamper);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetSize(PDFStamper stamper, PDFStampSizeMode sizeMode, float a, float b);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetPosition(PDFStamper stamper, float horizontalDistance, float verticalDistance, bool usePercentage);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetAlignment(PDFStamper stamper, PDFStampHAlign hAlign, PDFStampVAlign vAlign);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetRotation(PDFStamper stamper, float degrees);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetOpacity(PDFStamper stamper, float opacity);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetAsBackground(PDFStamper stamper, bool background);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetAsAnnotation(PDFStamper stamper, bool annotation);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperShowsOnScreen(PDFStamper stamper, bool onScreen);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperShowsOnPrint(PDFStamper stamper, bool onPrint);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperShowsInLayersPanel(PDFStamper stamper, bool inLayersPanel);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetName(PDFStamper stamper, const wchar_t* name);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetFont(PDFStamper stamper, const PDFontInfo* fontInfo);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetFontColor(PDFStamper stamper, PDColorValue color);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetTextOutline(PDFStamper stamper, PDColorValue strokeColor, float strokeWidth);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperSetTextAlignment(PDFStamper stamper, PDFStampTextAlign textAlign);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperStampText(PDFStamper stamper, PDDoc destDoc, const wchar_t* text, const PDPageRange* destPages);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperStampImage(PDFStamper stamper, PDDoc destDoc, GXBitmap bitmap, const PDPageRange* destPages);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperStampImageFromFile(PDFStamper stamper, PDDoc destDoc, const wchar_t* imagePath, const PDPageRange* destPages);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperStampPage(PDFStamper stamper, PDDoc destDoc, PDDoc srcDoc, size_t srcPageIndex, const PDPageRange* destPages);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperHasStamps(PDDoc doc, const PDPageRange* pages, bool* pHasStamps);

PDF_STAMPER_API PDErrCode PDFSDK_CALLCONV PDFStamperDeleteStamps(PDDoc doc, const PDPageRange* pages);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_STAMPER_H_INCLUDED_