CalendarInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(6 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
−
Eine <code>CalendarInformation</code> beschreibt einen Kalendereintrag durch eine Liste von [[CalendarEntry (Objekt)|CalendarEntry-Objekten]] und einer Liste von [[TaskInformation (Objekt)|TaskInformation-Objekten]].
+
Eine <code>CalendarInformation</code> beschreibt einen Kalendereintrag durch eine Liste von [[CalendarEntryInformation (Objekt)|CalendarEntryInformation-Objekten]] und einer Liste von [[TaskInformation (Objekt)|TaskInformation-Objekten]].
  
 
==Attribute==
 
==Attribute==
Zeile 16: Zeile 16:
 
|-
 
|-
 
| <code>field</code>
 
| <code>field</code>
−
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 2
 
| 2
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| <code>root</code>
 
| <code>root</code>
Zeile 24: Zeile 29:
 
| Root-Element dieser Information
 
| Root-Element dieser Information
 
| 2
 
| 2
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 +
| 1
 
|-
 
|-
 
| <code>locale</code>
 
| <code>locale</code>
Zeile 41: Zeile 51:
 
|-
 
|-
 
| <code>calendar</code>
 
| <code>calendar</code>
−
| [[Collection]]&nbsp;<[[CalendarEntry]]>
+
| [[Collection]]&nbsp;<[[CalendarEntryInformation]]>
−
| Die Liste von CalendarEntry-Objekten
+
| Die Liste von CalendarEntryInformation-Objekten
−
| 2
+
| 2.0.3
 +
|}
 +
 
 +
==Methoden==
 +
{| class="prettytable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>dates([[Boolean]] startDays)</code>
 +
| [[Collection]]
 +
| Alle Termine bzw. Tage eines Termins als Liste von [[Long]]-Objekten ausgeben
 +
| 2.10.5
 +
|-
 +
| <code>dates()</code>
 +
| [[Collection]]
 +
| Alle Termine bzw. Tage eines Termins als Liste von [[Long]]-Objekten ausgeben
 +
| 2.10.5
 +
|-
 +
| <code>toXip([[Boolean]] emptyFields)</code>
 +
| String
 +
| Erzeugt XML-Daten im XIP-Format für dieses Objekt
 +
| 2.14
 
|}
 
|}
  
 +
;<code>[[Collection]] dates([[Boolean]] startDays)</code>
 +
:
 +
:;Parameter
 +
::;<code>startDays</code>
 +
:::true: Bei mehrtägigen Terminen nur den Start-Tag berücksichtigen, false: Alle Tage ausgeben
 +
:;Rückgabewert
 +
::;Collection
 +
:::Alle Termine bzw. Tage eines Termins als Liste von [[Long]]-Objekten
 +
 +
;<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>

Aktuelle Version vom 4. November 2015, 14:10 Uhr

Name

CalendarInformation - Kalendareintrag für ein Element

Beschreibung

Eine CalendarInformation beschreibt einen Kalendereintrag durch eine Liste von CalendarEntryInformation-Objekten und einer Liste von TaskInformation-Objekten.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Objektes 2
field String Variablenname des Objektes 2
lastField String Variablenname des Objektes ohne Struktur-Date 2.13
root Element Root-Element dieser Information 2
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 2
isEmpty Boolean true, wenn das Objekt leer ist 2
tasks Collection <TaskInformation> Die Liste von TaskInformation-Objekten 2
calendar Collection <CalendarEntryInformation> Die Liste von CalendarEntryInformation-Objekten 2.0.3

Methoden

Methode Rückgabewert Beschreibung ab IES Version
dates(Boolean startDays) Collection Alle Termine bzw. Tage eines Termins als Liste von Long-Objekten ausgeben 2.10.5
dates() Collection Alle Termine bzw. Tage eines Termins als Liste von Long-Objekten ausgeben 2.10.5
toXip(Boolean emptyFields) String Erzeugt XML-Daten im XIP-Format für dieses Objekt 2.14
Collection dates(Boolean startDays)
Parameter
startDays
true: Bei mehrtägigen Terminen nur den Start-Tag berücksichtigen, false: Alle Tage ausgeben
Rückgabewert
Collection
Alle Termine bzw. Tage eines Termins als Liste von Long-Objekten
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
Abgerufen von „https://wiki.sitepark.com/index.php?title=CalendarInformation_(Objekt)&oldid=7770“