ExcelWorkbookInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(8 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 6: Zeile 6:
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 16: Zeile 16:
 
|-
 
|-
 
| field
 
| field
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 1
 
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| root
 
| root
 
| [[Element]]
 
| [[Element]]
 
| Root-Element dieser Information
 
| Root-Element dieser Information
 +
| 1
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 
| 1
 
| 1
 
|-
 
|-
Zeile 52: Zeile 62:
 
| format
 
| format
 
| [[String]]
 
| [[String]]
| Binärformat (pdf, doc, ...)
+
| Liefert immer <code>xls</code>
 
| 1
 
| 1
 
|-
 
|-
 
| mime
 
| mime
 
| [[String]]
 
| [[String]]
| MIME-Typ (<code>application/pdf</code>, <code>application/msword</code>, ...)
+
| Liefert immer (<code>application/vnd.ms-excel</code>)
 
| 1
 
| 1
 
|-
 
|-
Zeile 71: Zeile 81:
 
|-
 
|-
 
| sheets
 
| sheets
| [[Collection]]
+
| [[Collection]]&nbsp;<[[ExcelSheet]]>
 
| Liste der [[ExcelSheet]]-Objekte
 
| Liste der [[ExcelSheet]]-Objekte
 
| 1
 
| 1
 
|}
 
|}
  
 +
==Methoden==
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>reader([[String]] charsetName)</code>
 +
| Reader
 +
| Liefert eine Reader für die Binärdaten zurück. Dieser kann z.B. mit sp:print ausgegeben werden, um die Binäredaten selbst im Template auszugeben.
 +
| 2.5.4
 +
|-
 +
| <code>toXip([[Boolean]] emptyFields)</code>
 +
| String
 +
| Erzeugt XML-Daten im XIP-Format für dieses Objekt
 +
| 2.14
 +
|}
 +
 +
;<code>[[String]] reader([[String]] charsetName)</code>
 +
:Liefert eine Reader für die Binärdaten zurück. Dieser kann z.B. mit sp:print ausgegeben werden, um die Binäredaten selbst im Template auszugeben.
 +
:;Parameter
 +
::;<code>String charsetName</code>  (Optional)
 +
:::Charset mit dem die Binärdaten interpretiert werden sollen. Dieser Parameter ist Optional. Wird dieser Parameter nicht angegeben, wird UTF-8 verwendet.
 +
:;Rückgabewert
 +
::;Reader
 +
:::Reader der Binäredaten.
 +
 +
;<code>[[String]] toXip([[Boolean]] emptyFields)</code>
 +
:Erzeugt XML-Daten im XIP-Format für dieses Objekt.
 +
:;Parameter
 +
::;<code>Boolean emptyFields</code>
 +
:::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
 +
:;Rückgabewert
 +
::;String
 +
:::XML-Daten im XIP-Format
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_der_Sprache_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 4. November 2015, 13:12 Uhr

Name

ExcelWorkbookInformation - Excel-Datei

Beschreibung

Das ExcelWorkbookInformation-Objekt repräsentiert eine Excel-Datei.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Objektes 1
field String Variablenname des Objektes 1
lastField String Variablenname des Objektes ohne Struktur-Date 2.13
root Element Root-Element dieser Information 1
parent ID ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein 1
locale Locale Sprache, für die die Information gilt 1
isEmpty Boolean true, wenn die Größe der Binäredaten 0 ist 1
binary ID ID, unter der die Bilddaten selbst erreichbar sind 1
filename String Dateiname des Bildes 1
filesize Number Dateigröße in Bytes 1
format String Liefert immer xls 1
mime String Liefert immer (application/vnd.ms-excel) 1
isImage Boolean Liefert immer false 1
isExcel Boolean Liefert immer true 1
sheets Collection <ExcelSheet> Liste der ExcelSheet-Objekte 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
reader(String charsetName) Reader Liefert eine Reader für die Binärdaten zurück. Dieser kann z.B. mit sp:print ausgegeben werden, um die Binäredaten selbst im Template auszugeben. 2.5.4
toXip(Boolean emptyFields) String Erzeugt XML-Daten im XIP-Format für dieses Objekt 2.14
String reader(String charsetName)
Liefert eine Reader für die Binärdaten zurück. Dieser kann z.B. mit sp:print ausgegeben werden, um die Binäredaten selbst im Template auszugeben.
Parameter
String charsetName (Optional)
Charset mit dem die Binärdaten interpretiert werden sollen. Dieser Parameter ist Optional. Wird dieser Parameter nicht angegeben, wird UTF-8 verwendet.
Rückgabewert
Reader
Reader der Binäredaten.
String toXip(Boolean emptyFields)
Erzeugt XML-Daten im XIP-Format für dieses Objekt.
Parameter
Boolean emptyFields
Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
Rückgabewert
String
XML-Daten im XIP-Format