Inheritance diagram for IDataUpdaterFacade:

Public Types
enum	{ kDefaultIID = IID_IDATAUPDATERFACADE }

Public Member Functions
virtual bool16	CanInsertData (ITextModel *iTextModel, TextIndex textIndex, int32 length)=0

virtual ErrorCode	InsertData (ITextModel *iTextModel, TextIndex &textIndex, int32 length, const WideString &table, const WideString &record, const WideString &field, const WideString &value)=0

virtual ErrorCode	InsertAllData (ITextModel *iTextModel, TextIndex &textIndex, const IDFile &file)=0

virtual ErrorCode	UpdateData (const UIDRef &docUIDRef, const IDFile &file)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

From SDK sample; Abstract facade interface that encapsulates XMLDataUpdater features and functionality.

Member Function Documentation

virtual bool16 IDataUpdaterFacade::CanInsertData	(	ITextModel *	iTextModel,
		TextIndex	textIndex,
		int32	length
	)

pure virtual

Determine if data can be inserted.

Parameters

iTextModel	IN the text model of the target story.
textIndex	IN the start of the range of text to examine.
length	the IN length of the range of text to examine. Return kSuccess if tag can be inserted, other ErrorCode otherwise.

virtual ErrorCode IDataUpdaterFacade::InsertAllData	(	ITextModel *	iTextModel,
		TextIndex &	textIndex,
		const IDFile &	file
	)

pure virtual

Create all data for each value in the given CSV file.

Parameters

iTextModel	IN the text model of the target story.
textIndex	IN the position in the text to insert the data.
file	IN CSV file containing the data.

virtual ErrorCode IDataUpdaterFacade::InsertData	(	ITextModel *	iTextModel,
		TextIndex &	textIndex,
		int32	length,
		const WideString &	table,
		const WideString &	record,
		const WideString &	field,
		const WideString &	value
	)

pure virtual

Insert a xml tagged data.

Parameters

iTextModel	IN the text model of the target story.
textIndex	IN the start of the range of text to examine.
length	the IN length of the range of text to examine.
table	IN the table for the data tag (see IDataUpdaterDataTagTextAttr::SetTable).
record	IN the key for the data tag (see IDataUpdaterDataTagTextAttr::SetKey).
field	IN the field for the data tag (see IDataUpdaterDataTagTextAttr::SetField).
value	IN the value for the data tag (see IDataUpdaterDataTagTextAttr::SetValue).

virtual ErrorCode IDataUpdaterFacade::UpdateData	(	const UIDRef &	docUIDRef,
		const IDFile &	file
	)

pure virtual

Look for XML tagged data in all stories in the given document and update their values if they can be updated with the data from new file.

Parameters

docUIDRef	IN the target document.
file	IN CSV file containing data to be used to update xmldataupdater data tags in the document.