HiraokaHyperTools.iTextSharp-LGPL  0.2.5
iTextSharp.text.pdf.PdfLayerMembership Class Reference
Inheritance diagram for iTextSharp.text.pdf.PdfLayerMembership:
iTextSharp.text.pdf.PdfDictionary iTextSharp.text.pdf.IPdfOCG iTextSharp.text.pdf.PdfObject

Public Member Functions

 PdfLayerMembership (PdfWriter writer)
 
void AddMember (PdfLayer layer)
 
- Public Member Functions inherited from iTextSharp.text.pdf.PdfDictionary
 PdfDictionary ()
 
 PdfDictionary (PdfName type)
 
override void ToPdf (PdfWriter writer, Stream os)
 
void Put (PdfName key, PdfObject value)
 
void PutEx (PdfName key, PdfObject value)
 
void Remove (PdfName key)
 
PdfObject Get (PdfName key)
 
bool IsFont ()
 
bool IsPage ()
 
bool IsPages ()
 
bool IsCatalog ()
 
bool IsOutlineTree ()
 
void Merge (PdfDictionary other)
 
void MergeDifferent (PdfDictionary other)
 
bool Contains (PdfName key)
 
virtual IDictionaryEnumerator GetEnumerator ()
 
override String ToString ()
 
PdfObject GetDirectObject (PdfName key)
 
PdfDictionary GetAsDict (PdfName key)
 
PdfArray GetAsArray (PdfName key)
 
PdfStream GetAsStream (PdfName key)
 
PdfString GetAsString (PdfName key)
 
PdfNumber GetAsNumber (PdfName key)
 
PdfName GetAsName (PdfName key)
 
PdfBoolean GetAsBoolean (PdfName key)
 
PdfIndirectReference GetAsIndirectObject (PdfName key)
 
- Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
virtual byte[] GetBytes ()
 
bool CanBeInObjStm ()
 
override string ToString ()
 
bool IsNull ()
 
bool IsBoolean ()
 
bool IsNumber ()
 
bool IsString ()
 
bool IsName ()
 
bool IsArray ()
 
bool IsDictionary ()
 
bool IsStream ()
 
bool IsIndirect ()
 

Static Public Attributes

static readonly PdfName ALLON = new PdfName("AllOn")
 
static readonly PdfName ANYON = new PdfName("AnyOn")
 
static readonly PdfName ANYOFF = new PdfName("AnyOff")
 
static readonly PdfName ALLOFF = new PdfName("AllOff")
 
- Static Public Attributes inherited from iTextSharp.text.pdf.PdfDictionary
static PdfName FONT = PdfName.FONT
 
static PdfName OUTLINES = PdfName.OUTLINES
 
static PdfName PAGE = PdfName.PAGE
 
static PdfName PAGES = PdfName.PAGES
 
static PdfName CATALOG = PdfName.CATALOG
 
- Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int BOOLEAN = 1
 
const int NUMBER = 2
 
const int STRING = 3
 
const int NAME = 4
 
const int ARRAY = 5
 
const int DICTIONARY = 6
 
const int STREAM = 7
 
const int NULL = 8
 
const int INDIRECT = 10
 
const string NOTHING = ""
 
const string TEXT_PDFDOCENCODING = "PDF"
 
const string TEXT_UNICODE = "UnicodeBig"
 

Properties

PdfIndirectReference Ref [get]
 
ICollection Layers [get]
 
PdfName VisibilityPolicy [set]
 
PdfObject PdfObject [get]
 
- Properties inherited from iTextSharp.text.pdf.PdfDictionary
ICollection Keys [get]
 
int Size [get]
 
- Properties inherited from iTextSharp.text.pdf.PdfObject
int Length [get]
 
string Content [set]
 
int Type [get]
 
PRIndirectReference IndRef [get, set]
 
- Properties inherited from iTextSharp.text.pdf.IPdfOCG
PdfIndirectReference Ref [get]
 
PdfObject PdfObject [get]
 

Additional Inherited Members

- Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
 PdfObject (int type)
 
 PdfObject (int type, string content)
 
 PdfObject (int type, byte[] bytes)
 
- Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[] bytes
 
int type
 
PRIndirectReference indRef
 

Detailed Description

Content typically belongs to a single optional content group, and is visible when the group is ON and invisible when it is OFF. To express more complex visibility policies, content should not declare itself to belong to an optional content group directly, but rather to an optional content membership dictionary represented by this class.

Author
Paulo Soares (psoar.nosp@m.es@c.nosp@m.onsis.nosp@m.te.p.nosp@m.t)

Constructor & Destructor Documentation

◆ PdfLayerMembership()

iTextSharp.text.pdf.PdfLayerMembership.PdfLayerMembership ( PdfWriter  writer)

Creates a new, empty, membership layer.

Parameters
writerthe writer

Member Function Documentation

◆ AddMember()

void iTextSharp.text.pdf.PdfLayerMembership.AddMember ( PdfLayer  layer)

Adds a new member to the layer.

Parameters
layerthe new member to the layer

Member Data Documentation

◆ ALLOFF

readonly PdfName iTextSharp.text.pdf.PdfLayerMembership.ALLOFF = new PdfName("AllOff")
static

Visible only if all of the entries are OFF.

◆ ALLON

readonly PdfName iTextSharp.text.pdf.PdfLayerMembership.ALLON = new PdfName("AllOn")
static

Visible only if all of the entries are ON.

◆ ANYOFF

readonly PdfName iTextSharp.text.pdf.PdfLayerMembership.ANYOFF = new PdfName("AnyOff")
static

Visible if any of the entries are OFF.

◆ ANYON

readonly PdfName iTextSharp.text.pdf.PdfLayerMembership.ANYON = new PdfName("AnyOn")
static

Visible if any of the entries are ON.

Property Documentation

◆ Layers

ICollection iTextSharp.text.pdf.PdfLayerMembership.Layers
get

Gets the member layers.

Returns
the member layers

◆ PdfObject

PdfObject iTextSharp.text.pdf.PdfLayerMembership.PdfObject
get

Gets the dictionary representing the membership layer. It just returns this.

Returns
the dictionary representing the layer

◆ Ref

PdfIndirectReference iTextSharp.text.pdf.PdfLayerMembership.Ref
get

Gets the PdfIndirectReference that represents this membership layer.

Returns
the PdfIndirectReference that represents this layer

◆ VisibilityPolicy

PdfName iTextSharp.text.pdf.PdfLayerMembership.VisibilityPolicy
set

Sets the visibility policy for content belonging to this membership dictionary. Possible values are ALLON, ANYON, ANYOFF and ALLOFF. The default value is ANYON.

Parameters
typethe visibility policy

The documentation for this class was generated from the following file: