Difference between revisions of "Data 1 0-trimStringByWordCount"

From ADF Docs
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
Attention: Do not change any text in the description, signature, and paramter sections.
 +
 +
Return to [[Data_1_0]]
 +
 
== Description ==  
 
== Description ==  
 
Shortens a string without cutting words in half and appends '...' to the end.
 
Shortens a string without cutting words in half and appends '...' to the end.
  
== Signature ==
+
== Signature ==  
 
+
public String <strong>trimStringByWordCount</strong> ( string str, numeric words, boolean useEllipsis )
Signature
 
  
== Parameters ==
+
== Parameters ==  
  
Parameters
+
<table id="lib-params">
 +
<tr class="header">
 +
<td>Required</td>
 +
<td>Name</td>
 +
<td>Type</td>
 +
<td>Description</td>
 +
</tr>
 +
 +
 +
<tr>
 +
 +
<td class="required">required</td>
 +
 +
<td>str</td>
 +
<td>string</td>
 +
<td>The string to modify</td>
 +
</tr>
 +
 +
<tr>
 +
 +
<td>&nbsp;</td>
 +
 +
<td>words</td>
 +
<td>numeric</td>
 +
<td>The number of words to display</td>
 +
</tr>
 +
 +
<tr>
 +
 +
<td class="required">optional</td>
 +
 +
<td>useEllipsis</td>
 +
<td>boolean</td>
 +
<td>[Default: true] Option to turn off the Ellipsis [...] at the end of the trimed string</td>
 +
</tr>
 +
 +
</table>

Latest revision as of 12:46, 9 April 2010

Attention: Do not change any text in the description, signature, and paramter sections.

Return to Data_1_0

Description

Shortens a string without cutting words in half and appends '...' to the end.

Signature

public String trimStringByWordCount ( string str, numeric words, boolean useEllipsis )

Parameters

Required Name Type Description
required str string The string to modify
  words numeric The number of words to display
optional useEllipsis boolean [Default: true] Option to turn off the Ellipsis [...] at the end of the trimed string