InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
IStripCharService Class Referenceabstract

#include <IStripCharService.h>

Inheritance diagram for IStripCharService:
IPMUnknown

Public Member Functions

virtual void GetReplacedChars (K2Vector< TextCharPair > &replaceCharList, const K2Vector< ServiceID > &stripServices, textchar *replaceWith=nil)=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

This service is used for stripping invalid characters out of text so that it will not be displayed in the UI or saved as the name for something.

Member Function Documentation

virtual void IStripCharService::GetReplacedChars (K2Vector< TextCharPair > & replaceCharList,
const K2Vector< ServiceID > & stripServices,
textchar * replaceWith = nil 
)
pure virtual

Checks the serviceID passed in and fills the registeredCharList with pairs which contain characters that should be removed and the character they should be replaced with

Parameters
replaceCharList- Filled with a list of characters to not allow which maps to a list of characters to replace them with
stripServices- The service IDs to use when determining which characters to strip.
replaceWith- Can be used to specify which character to replace an invalid character with (nil will result in default)