Difference between revisions of "Documentation/DevGuide/OfficeDev/Applying Number Formats"

From Apache OpenOffice Wiki
Jump to: navigation, search
m (FINAL VERSION FOR L10N)
 
Line 19: Line 19:
  
 
The interface <idl>com.sun.star.util.XNumberFormatter</idl> converts numbers to strings, or strings to numbers, or detects a number format matching a given string.
 
The interface <idl>com.sun.star.util.XNumberFormatter</idl> converts numbers to strings, or strings to numbers, or detects a number format matching a given string.
−
<source lang="idl">
+
<syntaxhighlight lang="idl">
 
   void attachNumberFormatsSupplier ( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier )
 
   void attachNumberFormatsSupplier ( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier )
 
   com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier ()
 
   com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier ()
Line 36: Line 36:
 
    
 
    
 
   string getInputString ( [in] long nKey, [in] double fValue )
 
   string getInputString ( [in] long nKey, [in] double fValue )
−
</source>
+
</syntaxhighlight>
 
==== XNumberformatPreviewer ====
 
==== XNumberformatPreviewer ====
−
<source lang="idl">
+
<syntaxhighlight lang="idl">
 
   string convertNumberToPreviewString ( [in] string aFormat, [in] double fValue,  
 
   string convertNumberToPreviewString ( [in] string aFormat, [in] double fValue,  
 
                                 [in] com::sun::star::lang::Locale nLocale,  
 
                                 [in] com::sun::star::lang::Locale nLocale,  
Line 47: Line 47:
 
                                 [in] boolean bAllowEnglish,  
 
                                 [in] boolean bAllowEnglish,  
 
                                 [in] com::sun::star::util::color aDefaultColor )  
 
                                 [in] com::sun::star::util::color aDefaultColor )  
−
</source>
+
</syntaxhighlight>
 
This interface <idl>com.sun.star.util.XNumberFormatPreviewer</idl> converts values to strings according to a given format code without inserting the format code into the underlying <idl>com.sun.star.util.NumberFormats</idl> collection.
 
This interface <idl>com.sun.star.util.XNumberFormatPreviewer</idl> converts values to strings according to a given format code without inserting the format code into the underlying <idl>com.sun.star.util.NumberFormats</idl> collection.
  
 
The example below demonstrates the usage of these interfaces.  
 
The example below demonstrates the usage of these interfaces.  
 
<!--[SOURCE:OfficeDev/Number_Formats.java]-->
 
<!--[SOURCE:OfficeDev/Number_Formats.java]-->
−
<source lang="java">
+
<syntaxhighlight lang="java">
 
   public void doSampleFunction() throws RuntimeException, Exception
 
   public void doSampleFunction() throws RuntimeException, Exception
 
   {
 
   {
Line 136: Line 136:
 
           xCellProp.setPropertyValue( "NumberFormat", new Integer(nIndexKey) );
 
           xCellProp.setPropertyValue( "NumberFormat", new Integer(nIndexKey) );
 
   }
 
   }
−
</source>
+
</syntaxhighlight>
 
{{PDL1}}
 
{{PDL1}}
  
 
[[Category:Documentation/Developer's Guide/Office Development]]
 
[[Category:Documentation/Developer's Guide/Office Development]]

Latest revision as of 12:33, 3 January 2021



To format numeric values, an XNumberFormatsSupplier is attached to an instance of a com.sun.star.util.NumberFormatter, available at the global service manager. For this purpose, its main interface com.sun.star.util.XNumberFormatter has a method attachNumberFormatsSupplier(). When the XNumberFormatsSupplier is attached, strings and numeric values are formatted using the methods of the NumberFormatter. To specify the format to apply, you have to get the unique index key for one of the formats defined in NumberFormats. These keys are available at the XNumberFormats and XNumberFormatTypes interface of NumberFormats.

Numbers in documents, such as in table cells, formulas, and text fields, are formatted by applying the format key to the NumberFormat property of the appropriate element.

NumberFormatter Service

The service com.sun.star.util.NumberFormatter implements the interfaces com.sun.star.util.XNumberFormatter and com.sun.star.util.XNumberFormatPreviewer.

XNumberformatter

The interface com.sun.star.util.XNumberFormatter converts numbers to strings, or strings to numbers, or detects a number format matching a given string. 

  void attachNumberFormatsSupplier ( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier )
  com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier ()
 
  long detectNumberFormat ( [in] long nKey, [in] string aString ) 
 
  double convertStringToNumber ( [in] long nKey, [in] string aString ) 
  string convertNumberToString ( [in] long nKey, [in] double fValue ); 
 
  com::sun::star::util::color queryColorForNumber ( [in] long nKey, [in] double fValue, 
                                               [in] com::sun::star::util::color aDefaultColor )
  string formatString ( [in] long nKey, [in] string aString ); 
 
  com::sun::star::util::color queryColorForString ( [in] long nKey, [in] string aString, 
                                               [in] com::sun::star::util::color aDefaultColor )
 
  string getInputString ( [in] long nKey, [in] double fValue )

XNumberformatPreviewer

  string convertNumberToPreviewString ( [in] string aFormat, [in] double fValue, 
                                 [in] com::sun::star::lang::Locale nLocale, 
                                 [in] boolean bAllowEnglish ) 
 
  com::sun::star::util::color queryPreviewColorForNumber ( [in] string aFormat, [in] double fValue, 
                                 [in] com::sun::star::lang::Locale nLocale, 
                                 [in] boolean bAllowEnglish, 
                                 [in] com::sun::star::util::color aDefaultColor )

This interface com.sun.star.util.XNumberFormatPreviewer converts values to strings according to a given format code without inserting the format code into the underlying com.sun.star.util.NumberFormats collection.

The example below demonstrates the usage of these interfaces. 

  public void doSampleFunction() throws RuntimeException, Exception
  {
      // Assume:
      // com.sun.star.sheet.XSpreadsheetDocument maSpreadsheetDoc;
      // com.sun.star.sheet.XSpreadsheet maSheet;
 
      // Query the number formats supplier of the spreadsheet document
      com.sun.star.util.XNumberFormatsSupplier xNumberFormatsSupplier =
          (com.sun.star.util.XNumberFormatsSupplier)
          UnoRuntime.queryInterface(
          com.sun.star.util.XNumberFormatsSupplier.class, maSpreadsheetDoc );
 
      // Get the number formats from the supplier
      com.sun.star.util.XNumberFormats xNumberFormats =
          xNumberFormatsSupplier.getNumberFormats();
 
      // Query the XNumberFormatTypes interface
      com.sun.star.util.XNumberFormatTypes xNumberFormatTypes =
          (com.sun.star.util.XNumberFormatTypes)
          UnoRuntime.queryInterface(
          com.sun.star.util.XNumberFormatTypes.class, xNumberFormats );
 
      // Get the number format index key of the default currency format,
      // note the empty locale for default locale
      com.sun.star.lang.Locale aLocale = new com.sun.star.lang.Locale();
      int nCurrencyKey = xNumberFormatTypes.getStandardFormat(
          com.sun.star.util.NumberFormat.CURRENCY, aLocale );
 
      // Get cell range B3:B11
      com.sun.star.table.XCellRange xCellRange =
          maSheet.getCellRangeByPosition( 1, 2, 1, 10 );
 
      // Query the property set of the cell range
      com.sun.star.beans.XPropertySet xCellProp =
          (com.sun.star.beans.XPropertySet)
          UnoRuntime.queryInterface(
          com.sun.star.beans.XPropertySet.class, xCellRange );
 
      // Set number format to default currency
      xCellProp.setPropertyValue( "NumberFormat", new Integer(nCurrencyKey) );
 
      // Get cell B3
      com.sun.star.table.XCell xCell = maSheet.getCellByPosition( 1, 2 );
 
      // Query the property set of the cell
      xCellProp = (com.sun.star.beans.XPropertySet)
          UnoRuntime.queryInterface(
          com.sun.star.beans.XPropertySet.class, xCell );
 
      // Get the number format index key of the cell's properties
      int nIndexKey = ((Integer) xCellProp.getPropertyValue( "NumberFormat" )).intValue();
 
      // Get the properties of the number format
      com.sun.star.beans.XPropertySet xProp = xNumberFormats.getByKey( nIndexKey );
 
      // Get the format code string of the number format's properties
      String aFormatCode = (String) xProp.getPropertyValue( "FormatString" );
      System.out.println( "FormatString: `" + aFormatCode + "'" );
 
      // Create an arbitrary format code
      aFormatCode = "\"wonderful \"" + aFormatCode;
 
      // Test if it is already present
      nIndexKey = xNumberFormats.queryKey( aFormatCode, aLocale, false );
 
      // If not, add to number formats collection
      if ( nIndexKey == -1 )
      {
          try
          {
              nIndexKey = xNumberFormats.addNew( aFormatCode, aLocale );
          }
          catch( com.sun.star.util.MalformedNumberFormatException ex )
          {
              System.out.println( "Bad number format code: " + ex );
              nIndexKey = -1;
          }
      }
 
      // Set the new format at the cell
      if ( nIndexKey != -1 )
          xCellProp.setPropertyValue( "NumberFormat", new Integer(nIndexKey) );
  }
Content on this page is licensed under the Public Documentation License (PDL).
Retrieved from "https://wiki.openoffice.org/w/index.php?title=Documentation/DevGuide/OfficeDev/Applying_Number_Formats&oldid=246892"
Personal tools
In other languages