iText 7 7.1.8 API
iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling Class Reference

Wrapper that represents tiling pattern of color space. More...

Inheritance diagram for iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling:
iText.Kernel.Pdf.Colorspace.PdfPattern iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Classes

class   PaintType
  A code that determines how the colour of the pattern cell shall be specified More...
 
class   TilingType
  A code that controls adjustments to the spacing of tiles relative to the device pixel grid More...
 

Public Member Functions

  Tiling (PdfStream pdfObject)
  Creates new instance from the iText.Kernel.Pdf.PdfStream object. This stream should have PatternType equals to 1. More...
 
  Tiling (float width, float height)
 
  Tiling (float width, float height, bool colored)
 
  Tiling (Rectangle bbox)
 
  Tiling (Rectangle bbox, bool colored)
 
  Tiling (float width, float height, float xStep, float yStep)
 
  Tiling (float width, float height, float xStep, float yStep, bool colored)
 
  Tiling (Rectangle bbox, float xStep, float yStep)
 
  Tiling (Rectangle bbox, float xStep, float yStep, bool colored)
 
virtual bool  IsColored ()
  Checks if this pattern have colored paint type. More...
 
virtual void  SetColored (bool colored)
  Sets the paint type. More...
 
virtual int  GetTilingType ()
  Gets the tiling type. More...
 
virtual void  SetTilingType (int tilingType)
  Sets the tiling type. More...
 
virtual Rectangle  GetBBox ()
  Gets the pattern cell's bounding box. More...
 
virtual void  SetBBox (Rectangle bbox)
  Sets the pattern cell's bounding box. More...
 
virtual float  GetXStep ()
 
virtual void  SetXStep (float xStep)
 
virtual float  GetYStep ()
 
virtual void  SetYStep (float yStep)
 
virtual PdfResources  GetResources ()
 
override void  Flush ()
  To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call iText.Kernel.Pdf.PdfObjectWrapper.MakeIndirect(iText.Kernel.Pdf.PdfDocument)For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfPattern
virtual PdfArray  GetMatrix ()
  Gets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. More...
 
virtual void  SetMatrix (PdfArray matrix)
  Sets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T  GetPdfObject ()
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document, PdfIndirectReference reference)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  SetModified ()
 
virtual bool  IsFlushed ()
 

Additional Inherited Members

- Static Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfPattern
static iText.Kernel.Pdf.Colorspace.PdfPattern  GetPatternInstance (PdfDictionary pdfObject)
  Creates the instance wrapper of correct type from the iText.Kernel.Pdf.PdfDictionary More...
 

Detailed Description

Wrapper that represents tiling pattern of color space.

Wrapper that represents tiling pattern of color space. This pattern consists of a small graphical figure (cells). Painting with the pattern replicates the cell at fixed horizontal and vertical intervals to fill an area. The pattern cell can include graphical elements such as filled areas, text, and sampled images. Its shape need not be rectangular, and the spacing of tiles can differ from the dimensions of the cell itself. The appearance of the pattern cell shall be defined by a content stream containing the painting operators needed to paint one instance of the cell

Constructor & Destructor Documentation

◆ Tiling()

Creates new instance from the iText.Kernel.Pdf.PdfStream object. This stream should have PatternType equals to 1.

Parameters
pdfObject the iText.Kernel.Pdf.PdfStream that represents Tiling Pattern.

Member Function Documentation

◆ Flush()

override void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.Flush ( )
inlinevirtual

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call iText.Kernel.Pdf.PdfObjectWrapper.MakeIndirect(iText.Kernel.Pdf.PdfDocument)For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation.

Reimplemented from iText.Kernel.Pdf.Colorspace.PdfPattern.

◆ GetBBox()

virtual Rectangle iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.GetBBox ( )
inlinevirtual

Gets the pattern cell's bounding box.

Gets the pattern cell's bounding box. These boundaries shall be used to clip the pattern cell.

Returns
pattern cell's bounding box.

◆ GetTilingType()

virtual int iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.GetTilingType ( )
inlinevirtual

Gets the tiling type.

Returns
int value of TilingType

◆ IsColored()

virtual bool iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.IsColored ( )
inlinevirtual

Checks if this pattern have colored paint type.

Returns

true if this pattern's paint type is PaintType.COLORED and false otherwise.

◆ SetBBox()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetBBox ( Rectangle  bbox )
inlinevirtual

Sets the pattern cell's bounding box.

Sets the pattern cell's bounding box. These boundaries shall be used to clip the pattern cell.

Parameters
bbox pattern cell's bounding box to set.

◆ SetColored()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetColored ( bool  colored )
inlinevirtual

Sets the paint type.

Parameters
colored if true then the paint type will be set as PaintType.COLORED , and PaintType.UNCOLORED otherwise.

◆ SetTilingType()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.SetTilingType ( int  tilingType )
inlinevirtual

Sets the tiling type.

Parameters
tilingType int value of TilingType to set.
Exceptions
System.ArgumentException in case of wrong value.