IPXV_PageTextSelection::SelectChars Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IPXV_PageTextSelection::SelectChars Method}}
 
{{#customTitle:IPXV_PageTextSelection::SelectChars Method}}
 
{{#parentPage:PXV:IPXV_PageTextSelection#Methods|SelectChars|method}}
 
{{#parentPage:PXV:IPXV_PageTextSelection#Methods|SelectChars|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Selects given character range on the page.
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;nFirstCharIndex
 
;nFirstCharIndex
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing an index of the first character that should be selectd.
 
;nCharsCount
 
;nCharsCount
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the number of characters that should be selected.
 
;bUpdate
 
;bUpdate
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL representing whether the selection should be invalidated.
 
;bExclusive
 
;bExclusive
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Value of VARIANT_BOOL representing whether the selection should be exclusive. An exclusive selection means that all of the selections made before will be cleared.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 05:12, 27 April 2017


Selects given character range on the page.

Syntax

HRESULT SelectChars([in]                    ULONG         nFirstCharIndex,
                    [in]                    ULONG         nCharsCount,
                    [in, defaultvalue(-1)]  VARIANT_BOOL  bUpdate,
                    [in, defaultvalue(0)]   VARIANT_BOOL  bExclusive);

Parameters

nFirstCharIndex
[in] Value of ULONG containing an index of the first character that should be selectd.
nCharsCount
[in] Value of ULONG containing the number of characters that should be selected.
bUpdate
[in, defaultvalue(-1)] Value of VARIANT_BOOL representing whether the selection should be invalidated.
bExclusive
[in, defaultvalue(0)] Value of VARIANT_BOOL representing whether the selection should be exclusive. An exclusive selection means that all of the selections made before will be cleared.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_PageTextSelection