SnpPerformNoteFunction Class Reference

Public Member Functions
ErrorCode	AddANote (ISnpRunnableContext *runnableContext)
ErrorCode	InsertText (ISnpRunnableContext *runnableContext, UIDRef targetStory, TextIndex indexStart, TextIndex indexEnd)
ErrorCode	OpenCloseNote (ISnpRunnableContext *runnableContext)
ErrorCode	ShowHideNote ()
ErrorCode	NavigateNote (ISnpRunnableContext *runnableContext, INoteSuite::NavigateType navType)
ErrorCode	ConvertTextToNote (ISnpRunnableContext *runnableContext)
ErrorCode	ConvertNoteToText (ISnpRunnableContext *runnableContext, UIDRef targetStory, TextIndex indexStart, TextIndex indexEnd)
ErrorCode	DeleteNote (ISnpRunnableContext *runnableContext)
ErrorCode	RemoveAllNote (ISnpRunnableContext *runnableContext)
ErrorCode	SplitNote (ISnpRunnableContext *runnableContext)

Detailed Description

• How to manipulate note through INoteSuite.
• How to check note's visibility state.
• How to insert text into note.

See Also

INoteSuite

INoteSuiteUtils

INoteSettings

Member Function Documentation

ErrorCode SnpPerformNoteFunction::AddANote

(

ISnpRunnableContext *

runnableContext

)

Add a note at the current text cursor position.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::ConvertNoteToText	(	ISnpRunnableContext *	runnableContext,
		UIDRef	targetStory,
		TextIndex	indexStart,
		TextIndex	indexEnd
	)

Convert the selected note into text.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::ConvertTextToNote

(

ISnpRunnableContext *

runnableContext

)

Convert the selected text into note.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::DeleteNote

(

ISnpRunnableContext *

runnableContext

)

Delete the selected note.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::InsertText	(	ISnpRunnableContext *	runnableContext,
		UIDRef	targetStory,
		TextIndex	indexStart,
		TextIndex	indexEnd
	)

Insert text into the current position, if the cursor is inside the note, the text will go into the note.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::NavigateNote	(	ISnpRunnableContext *	runnableContext,
		INoteSuite::NavigateType	navType
	)

Given the current text cursor, go to the next/previous note and open the note if it is collpased.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::OpenCloseNote

(

ISnpRunnableContext *

runnableContext

)

Open a note if the selected note is collapsed, close a note if the selected note is expanded.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::RemoveAllNote

(

ISnpRunnableContext *

runnableContext

)

Remove all the notes from the document.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::ShowHideNote

(

)

Toggle all notes' visibility state.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpPerformNoteFunction::SplitNote

(

ISnpRunnableContext *

runnableContext

)

if text cursor is inside a note, split the note into 2 notes at the cursor position.

Returns

kSuccess on success, other ErrorCode otherwise.