SnpFindAndReplace Class Reference

Public Member Functions
	SnpFindAndReplace (void)
	~SnpFindAndReplace (void)
IFindChangeService::FindChangeResult	Do_FindText (const IFindChangeOptions::SearchMode searchMode, const PMString &findString, const IWalkerScopeFactoryUtils::WalkScopeType findScope, const bool16 entireWord=kFalse, const bool16 caseSensitive=kFalse, const bool16 distinguishKanaType=kFalse, const bool16 distinguishKanaWidths=kTrue)
IFindChangeService::FindChangeResult	Do_ReplaceText (const IFindChangeOptions::SearchMode searchMode, const PMString &findString, const PMString &replaceString, const IWalkerScopeFactoryUtils::WalkScopeType findScope, const ClassID &replaceMode, const bool16 entireWord=kFalse, const bool16 caseSensitive=kFalse, const bool16 distinguishKanaType=kFalse, const bool16 distinguishKanaWidths=kTrue)
IFindChangeService::FindChangeResult	Do_FindGlyph (const Text::GlyphID findGlyphID, const IWalkerScopeFactoryUtils::WalkScopeType findScope)
IFindChangeService::FindChangeResult	Do_ReplaceGlyph (const Text::GlyphID findGlyphID, const Text::GlyphID replaceGlyphID, const IWalkerScopeFactoryUtils::WalkScopeType findScope, const ClassID &replaceMode)
ErrorCode	ReportError (const IFindChangeService::FindChangeResult status)

Detailed Description

• How to set up and perform find change text,
• How to set up and perform find change text use grep (Grep search),
• How to set up and perform find change glyph,
• How to set up and perform find change frame object.

This snippet shows you how to do the equivalent of a search/replace in the find/change dialog. With this code snippet, you can either:

• find text,
• replace text.
• find text with grep,
• replace text with grep.
• find glyph,
• replace glyph.
• find object,
• replace object.

One of the most important interface for find/change is IFindChangeOptions. It caches/stores options that are needed to perform search or replace.

InDesign support find/change text, grep, glyph and object. They are specified in SearchMode in IFindChangeOptions, as kTextSearch, kGrepSearch, kGlyphSearch and kObjectSearch respectively.

Find/change functionalilty can be achive in following two steps:

• Set up find/change options
• Perform find or change Although these two step are coupled together in our sample code, they can separated executed. For example, you can set find/change text string and find/change glyph IDs first, then set search mode to kTextSearch and search for text. After that, reset search mode to kGlyphSearch and search for glyphs.

While this code snippet processes a multitude of commands to perform each task, there are still some useful find/change related commands that are not used in this code snippet.
[Commands for find/change based on formats]

• kReplaceAllApplyFormatCmdBoss
• kClearFindFormatCmdBoss: to clear the find format
• kClearChangeFormatCmdBoss: to clear the change format
  [Commands for find/change based on Japanese character types]
• kFindChangeModeCmdBoss: To set the find/replace mode between "Change" (for text) and "Transliterate" for Japanese character types. See IFindChangeOptions::ChangeMode. (NOTE: This code snippet assumes that "Change" is used, however if you want to search based on Japanese character types, you must first change the mode with this command.)
• kFindCharacterTypeCmdBoss: To set the find character type (see IFindChangeOptions::CharacterType)
• kReplaceCharacterTypeCmdBoss: To set the find character type (see IFindChangeOptions::CharacterType)
  [Commands for setting find/change scope options]
• kIncludeLockedStoriesForFindCmdBoss: Find only option, if include locked stories.
• kIncludeLockedLayersForFindCmdBoss: Find only option, if include locked layers.
• kIncludeHiddenLayersCmdBoss: Find/change include hidden layers?
• kIncludeMasterPagesCmdBoss: Find/change include master page items?
• kIncludeFootnotesCmdBoss: Find/change include text in foot notes?

See Also

IK2ServiceRegistry

IK2ServiceProvider

IFindChangeOptions

IFindChangeCmdData

ITextWalker

ITextWalkerScope

IWalkerScopeFactoryUtils

ITextWalkerSelectionUtils

IStringData

IIntData

IBoolData

kFindStringCmdBoss

kReplaceStringCmdBoss

kScopeCmdBoss

kFindTextCmdBoss

kTWReplaceTextCmdBoss

kReplaceFindTextCmdBoss

kReplaceAllTextCmdBoss

kEntireWordCmdBoss

kCaseSensitiveCmdBoss

kKanaSensitiveCmdBoss

kWidthSensitiveCmdBoss

Constructor & Destructor Documentation

SnpFindAndReplace::SnpFindAndReplace ( void  )

inline

Constructor.

SnpFindAndReplace::~SnpFindAndReplace ( void  )

inline

Destructor.

Member Function Documentation

IFindChangeService::FindChangeResult SnpFindAndReplace::Do_FindGlyph	(	const Text::GlyphID	findGlyphID,
		const IWalkerScopeFactoryUtils::WalkScopeType	findScope
	)

Calls a series of commands to find glyph.

Parameters

findGlyphID	IN The glyph to find.
findScope	IN The scope of the find and replace.

IFindChangeService::FindChangeResult SnpFindAndReplace::Do_FindText	(	const IFindChangeOptions::SearchMode	searchMode,
		const PMString &	findString,
		const IWalkerScopeFactoryUtils::WalkScopeType	findScope,
		const bool16	entireWord = kFalse,
		const bool16	caseSensitive = kFalse,
		const bool16	distinguishKanaType = kFalse,
		const bool16	distinguishKanaWidths = kTrue
	)

Calls a series of commands to find text or grep.

Parameters

searchMode	IN The serach mode. This method support either kTextSearch or kGrepSearch.
findString	IN The text or grep string to find.
findScope	IN The scope of the find.
entireWord	IN Whether to match the entire word or not. kTrue = match entire word. Default is kFalse.
caseSensitive	IN Whether to match in a case-sensitive manner or not. kTrue = case-sensitive. Default is kFalse
distinguishKanaType	IN Whether to match based on the type of kana (hiragana or katakana). kTrue = match based on type of kana. Default is kFalse.
distinguishKanaWidths	IN Whether to match based on kana width (half-width "hankaku", or full-width "zenkaku"). kTrue = match based on kana width. Default is kTrue.

Returns

Status code. See IFindChangeService::FindChangeResult

See Also

IFindChangeService::FindChangeResult

IFindChangeService::FindChangeResult SnpFindAndReplace::Do_ReplaceGlyph	(	const Text::GlyphID	findGlyphID,
		const Text::GlyphID	replaceGlyphID,
		const IWalkerScopeFactoryUtils::WalkScopeType	findScope,
		const ClassID &	replaceMode
	)

Calls a series of commands to find and replace glyph.

Parameters

findGlyphID	IN The glyph to find.
replaceGlyphID	IN The glyph to replace with.
findScope	IN The scope of the find and replace.
replaceMode	IN A command class ID that specifies which replacement mode to use. Only three are supported by this code snippet: (1) kTWReplaceTextCmdBoss, (2) kReplaceFindTextCmdBoss and (3) kReplaceAllCmdBoss.

See Also

IFindChangeService::FindChangeResult

IFindChangeService::FindChangeResult SnpFindAndReplace::Do_ReplaceText	(	const IFindChangeOptions::SearchMode	searchMode,
		const PMString &	findString,
		const PMString &	replaceString,
		const IWalkerScopeFactoryUtils::WalkScopeType	findScope,
		const ClassID &	replaceMode,
		const bool16	entireWord = kFalse,
		const bool16	caseSensitive = kFalse,
		const bool16	distinguishKanaType = kFalse,
		const bool16	distinguishKanaWidths = kTrue
	)

Calls a series of commands to find and replace text or with grep.

Parameters

searchMode	IN The serach mode. This method support either kTextSearch or kGrepSearch.
findString	IN The text/grep string to find.
findString	IN The text/grep string to replace with.
findScope	IN The scope of the find and replace.
replaceMode	IN A command class ID that specifies which replacement mode to use. Only three are supported by this code snippet: (1) kTWReplaceTextCmdBoss, (2) kReplaceFindTextCmdBoss and (3) kReplaceAllCmdBoss.
entireWord	IN Whether to match the entire word or not. kTrue = match entire word. Default is kFalse.
caseSensitive	IN Whether to match in a case-sensitive manner or not. kTrue = case-sensitive. Default is kFalse
distinguishKanaType	IN Whether to match based on the type of kana (hiragana or katakana). kTrue = match based on type of kana. Default is kFalse.
distinguishKanaWidths	IN Whether to match based on kana width (half-width "hankaku", or full-width "zenkaku"). kTrue = match based on kana width. Default is kTrue.

Returns

Status code. See IFindChangeService::FindChangeResult

See Also

IFindChangeService::FindChangeResult

ErrorCode SnpFindAndReplace::ReportError

(

const IFindChangeService::FindChangeResult

status

)

Reports the status returned from either Do_FindText or Do_ReplaceText.

Parameters

status

IN IFindChangeService::FindChangeResult returned from either Do_FindText or Do_ReplaceText.

Returns

General status code, indicating whether the code snippet succeeded or failed.

See Also

IFindChangeService::FindChangeResult

Do_FindText

Do_ReplaceText