PdsContentMark Struct Reference

PdsContentMark class. More...

Public Member Functions
virtual int	GetNumTags ()=0
	Gets the number of tags in the marked content. More...
virtual int	GetTagName (int index, wchar_t *buffer, int len)=0
	Gets the tag name by index. More...
virtual PdsDictionary *	GetTagObject (int index)=0
	Gets the tag dictionary by index. More...
virtual int	GetTagMcid ()=0
	Gets the marked-content identifier of the marked-content sequence within its content stream. More...
virtual bool	GetTagArtifact ()=0
	Returns true if the marked content is an Artifact. More...
virtual bool	AddTag (const char *name, PdsDictionary *object, bool indirect)=0
virtual bool	RemoveTag (int index)=0
	Removes the specified tag from the marked content. More...

Detailed Description

PdsContentMark class.

A PdsContentMark represents marked content for a page objects. It holds page objects with the same marked content. Any changes with mark content are applied for each page object from it's container.

Member Function Documentation

AddTag()

virtual bool PdsContentMark::AddTag ( const char *  name, PdsDictionary *  object, bool  indirect  )

pure virtual

Adds a new tag into the marked content. NOTE: Be carefull when using this method because it can lead to PDF tagged structure failure!

Parameters

name	The tag name.
object	The dictionary containing the property list or nullptr.
indirect	If true, creates the object as an indirect object. If false, creates the object as a direct object.

Returns

true if tag was added successfully, false otherwise.

GetNumTags()

virtual int PdsContentMark::GetNumTags ( )

pure virtual

Gets the number of tags in the marked content.

Returns

Number of tags in the marked content.

GetTagArtifact()

virtual bool PdsContentMark::GetTagArtifact ( )

pure virtual

Returns true if the marked content is an Artifact.

Returns

True if the marked-content is an artifact, false otherwise.

GetTagMcid()

virtual int PdsContentMark::GetTagMcid ( )

pure virtual

Gets the marked-content identifier of the marked-content sequence within its content stream.

Returns

MCID if exists, -1 otherwise.

GetTagName()

virtual int PdsContentMark::GetTagName ( int  index, wchar_t *  buffer, int  len  )

pure virtual

Gets the tag name by index.

Parameters

index	The index of tag whose value is obtained.
buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns

Number of characters written into buffer of required length.

GetTagObject()

virtual PdsDictionary* PdsContentMark::GetTagObject ( int  index )

pure virtual

Gets the tag dictionary by index.

Parameters

index

The index of tag whose value is obtained.

Returns

Tag object if exists, nullptr otherwise.

RemoveTag()

virtual bool PdsContentMark::RemoveTag ( int  index )

pure virtual

Removes the specified tag from the marked content.

Parameters

index

The index of the tag to remove.