OdPdfPublish::OdCollectionColumn Class Reference

#include <PdfPublishCollectionColumn.h>

Inheritance diagram for OdPdfPublish::OdCollectionColumn:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdCollectionColumn)
	ODRX_HEAP_OPERATORS ()
virtual	~OdCollectionColumn ()
void	setName (const OdString &name)
void	setCaption (const OdString &caption)
void	setColumnType (const CollectionSchema::ColumnType &type)
void	setVisibleOnStart (const bool val)
void	setEnableEdit (const bool val)
void	setSortOrder (const CollectionSchema::SortOrder &sort)
void	getName (OdString &name) const
void	getCaption (OdString &caption) const
void	getColumnType (CollectionSchema::ColumnType &type) const
void	getVisibleOnStart (bool &val) const
void	getEnableEdit (bool &val) const
void	getSortOrder (CollectionSchema::SortOrder &sort) const
Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)
	ODRX_HEAP_OPERATORS ()
virtual	~OdObject ()
virtual bool	isEmpty () const
virtual bool	isValid () const
virtual void	clear ()
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdCollectionColumn ()
Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

Detailed Description

This class implements an collection column entity in .pdf documents created with Publish SDK.

Definition at line 47 of file PdfPublishCollectionColumn.h.

Constructor & Destructor Documentation

OdCollectionColumn()

OdPdfPublish::OdCollectionColumn::OdCollectionColumn ( )

protected

~OdCollectionColumn()

virtual OdPdfPublish::OdCollectionColumn::~OdCollectionColumn ( )

virtual

Destroys an collection column object.

Member Function Documentation

getCaption()

void OdPdfPublish::OdCollectionColumn::getCaption

(

OdString &

caption

)

const

Returns the current caption of the collection column. The method fills a passed string object and returns it to the calling subroutine.

Parameters

caption

[out] A placeholder for caption value.

getColumnType()

void OdPdfPublish::OdCollectionColumn::getColumnType

(

CollectionSchema::ColumnType &

type

)

const

Returns the collection column type. The method fills a passed collection column type value and returns it to a calling subroutine.

Parameters

type	[out] A placeholder for the collection column type value.

See also

<link OdPdfPublish::CollectionSchema::ColumnType, CollectionSchema::ColumnType enumeration>.

getEnableEdit()

void OdPdfPublish::OdCollectionColumn::getEnableEdit

(

bool &

val

)

const

Sets the editability flag of the collection column.

Parameters

val	[in] A editability flag value.

getName()

void OdPdfPublish::OdCollectionColumn::getName

(

OdString &

name

)

const

Returns the current name of the collection column. The method fills a passed string object and returns it to the calling subroutine.

Parameters

name	[out] A placeholder for name value.

getSortOrder()

void OdPdfPublish::OdCollectionColumn::getSortOrder

(

CollectionSchema::SortOrder &

sort

)

const

Returns the sort type for the collection column type. The method fills a passed sort type value and returns it to a calling subroutine.

Parameters

sort	[out] A placeholder for the sort type value.

See also

<link OdPdfPublish::CollectionSchema::SortOrder, CollectionSchema::SortOrder enumeration>.

getVisibleOnStart()

void OdPdfPublish::OdCollectionColumn::getVisibleOnStart

(

bool &

val

)

const

Sets the visibility flag of the collection column.

Parameters

val	[in] A visibility flag value.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdCollectionColumn::ODRX_DECLARE_MEMBERS

(

OdCollectionColumn

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::OdCollectionColumn::ODRX_HEAP_OPERATORS

(

)

setCaption()

void OdPdfPublish::OdCollectionColumn::setCaption

(

const OdString &

caption

)

Sets the caption of the collection column.

Parameters

caption

[in] A new name value.

setColumnType()

void OdPdfPublish::OdCollectionColumn::setColumnType

(

const CollectionSchema::ColumnType &

type

)

Sets the type for the collection column. The type is represented with one of <link OdPdfPublish::CollectionSchema::ColumnType, column types>.

Parameters

type	[in] A new column type value.

See also

<link OdPdfPublish::CollectionSchema::ColumnType, CollectionSchema::ColumnType enumeration>.

setEnableEdit()

void OdPdfPublish::OdCollectionColumn::setEnableEdit

(

const bool

val

)

Sets the editability flag of the collection column.

Parameters

val	[in] A editability flag value.

setName()

void OdPdfPublish::OdCollectionColumn::setName

(

const OdString &

name

)

Sets the name of the collection column. Use IsValid() to check the status of the operation.

Parameters

name	[in] A new name value. The name shouldn't contain any special characters or spaces. To display the collection items, the collection should contain a column with the same name.

setSortOrder()

void OdPdfPublish::OdCollectionColumn::setSortOrder

(

const CollectionSchema::SortOrder &

sort

)

Sets the sort type for the collection column. The type is represented with one of <link OdPdfPublish::CollectionSchema::SortOrder, column sort types>.

Parameters

type	[in] A new column sort type value.

See also

<link OdPdfPublish::CollectionSchema::SortOrder, CollectionSchema::SortOrder enumeration>.

setVisibleOnStart()

void OdPdfPublish::OdCollectionColumn::setVisibleOnStart

(

const bool

val

)

Sets the visibility on start flag of the collection column.

Parameters

val	[in] A visibility flag value.

---

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

• PdfPublishCollectionColumn.h