InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IWatermarkData::WatermarkInfo Struct Reference

#include <IWatermarkData.h>

Public Types

enum  WatermarkHPos { kWatermarkHPosLeft = 0, kWatermarkHPosCenter, kWatermarkHPosRight }
 
enum  WatermarkVPos { kWatermarkVPosTop = 0, kWatermarkVPosCenter, kWatermarkVPosBottom }
 
typedef object_type data_type
 

Public Attributes

bool16 fVisibility
 
bool16 fDoPrint
 
bool16 fDrawInBack
 
WideString fText
 
WideString fFontFamily
 
WideString fFontStyle
 
int32 fFontPointSize
 
UID fFontColor
 
int32 fOpacity
 
int32 fRotation
 
WatermarkHPos fHorzPosition
 
PMReal fHorzOffset
 
WatermarkVPos fVertPosition
 
PMReal fVertOffset
 

Detailed Description

The data structure used to store and transfer information about the watermark. This structure contains constructors, Get, Set, and ReadWrite methods.

Member Data Documentation

bool16 IWatermarkData::WatermarkInfo::fDoPrint

Print flag, kTrue means print the watermark

bool16 IWatermarkData::WatermarkInfo::fDrawInBack

Draw In Back flag, kTrue means draw behind page items

UID IWatermarkData::WatermarkInfo::fFontColor

Font color to be displayed

WideString IWatermarkData::WatermarkInfo::fFontFamily

Font family to be displayed

int32 IWatermarkData::WatermarkInfo::fFontPointSize

Font point size of displayed watermark text

WideString IWatermarkData::WatermarkInfo::fFontStyle

Font style to be displayed

PMReal IWatermarkData::WatermarkInfo::fHorzOffset

Watermark horizontal page offset relative to position

WatermarkHPos IWatermarkData::WatermarkInfo::fHorzPosition

Watermark horizontal page position: center, left, right

int32 IWatermarkData::WatermarkInfo::fOpacity

Watermark opacity (as a percentage 0 to 100)

int32 IWatermarkData::WatermarkInfo::fRotation

Watermark rotation (positive or negative)

WideString IWatermarkData::WatermarkInfo::fText

Watermark string to be displayed

PMReal IWatermarkData::WatermarkInfo::fVertOffset

Watermark vertical page offset relative to position

WatermarkVPos IWatermarkData::WatermarkInfo::fVertPosition

Watermark vertical page position: center, top, bottom

bool16 IWatermarkData::WatermarkInfo::fVisibility

Display flag, kTrue means display the watermark