iPage ist eine der zentralen Klassen im System; Sie repräsentiert eine Seite.
Liefert die ID der Page
Model.Page.ID
Liefert den Namen der Page
Model.Page.Name
Liefert den Titel der Page
Model.Page.Title
Liefert die MetaKeywords der Page
Model.Page.MetaKeywords
Liefert die MetaDescription der Page
Model.Page.MetaDescription
Gibt true zurück wenn die Page aktiv ist, false wenn nicht
Da es kein Aktiv mehr gibt liefert die Property ob die Seite einen Published-Stand hat!
Model.Page.Active
Gibt true zurück wenn die Page durch einen Login geschützt ist, false wenn nicht.
Model.Page.IsLoginRequired
Gibt true zurück wenn die Page sichtbar ist, false wenn nicht
Model.Page.IsVisible
Gibt true zurück ob die Sichtbarkeit der Seite geändert werden darf
Model.Page.IsChangeable
Gibt true zurück wenn die Seite gelöscht werden darf
Model.Page.IsDeletable
Gibt true zurück wenn die Seite mit einem NoIndex Tag versehen werden soll.
Model.Page.NoIndex
Liefert die Position der Page
Model.Page.Rank
Liefert die SprachenID der Page
Model.Page.LanguageID
Model.Page.NavigationID
Liefert die H1 der Page
Model.Page.Headline
Liefert die Version des Datensatzes. Pro Änderung an einem Objekt wird die Version erhöht.
Model.Page.Version
Liefert das Datum wann die Page erstellt wurde
Model.Page.CreatedOn
Liefert den Administrator der die Page erstellt hat
Model.Page.Creator
Liefert das Datum wann die Page das letzte mal geändert wurde.
Liefert den Administrator der die Page als letztes geändert hat.
Gibt den Zeitpunkt der neuesten Publish-Aktion an.
Liefert true wenn es Unterseiten gibt, false wenn nicht
Model.Page.HasSubPages
true, falls die Seite jemals veröffentlicht wurde.
Model.Page.HasEverBeenPublished
Liefert true wenn es eine Seite auf der ersten Ebene ist, false wenn nicht
Model.Page.IsFirstLevel
Liefert das Elternelement als Objekt vom Typ iPage
Model.Page.Parent
Liefert aus der Liste der selben Ebene die vorherige Page
Model.Page.PreviousPage
Liefert aus der Liste der selben Ebene die nächste Page
Model.Page.NextPage
Liefert die URL der Page
Model.Page.URL
Liefert den Page Typen der Page
Model.Page.PageType
Gibt die Ebene (=Verschachtelungstiefe im Baum) zurück, in der sich die Seite befindet.
Bsp: Eine Hauptseite der obersten Ebene liefert 1, ihre Unterseiten jeweils 2, die Unterseiten der Unterseite 3, usw.
Model.Page.TreeLevel
Liefert den Pfad der Page
Model.Page.Path(" <i class=""cico cico-caret-right-b""></i> ", True)
Liefert true wenn die Page die übergeben wird er selbst ist oder als Unterseite enthalten ist
Model.Page.IsOrContains(22)
Gibt an, ob die Seite derzeit von einem Administrator oder Benutzer zur Bearbeitung ausgecheckt ist
Model.Page.IsCheckedOut
Liefert alle Unterseiten der ersten Ebene
Model.Page.SubPages()
Liefert alle Unterseiten als iPage-Liste anhand eines PageTypes.
Liefert alle Unterseiten als iPage-Liste anhand der Liste von PageTypes.
Liefert alle Unterseiten rekursiv als iPage-Liste.
Function SubPagesByType(Type As iPageType, Optional ExcludeType As Boolean = False, Optional WithInactive As Boolean = False, Optional WithInvisible As Boolean = True) As List(Of iPage)
Model.Page.SubPagesByType(Pages.GetPage(10, True).PageType)
Liefert alle Unterseiten eines bestimmten Typs. Standardmäßig werden alle Unterseiten des gegebenen Typs ohne inaktive Seiten geliefert.
Dim PageTypeList As New List(Of iPageType)
PageTypeList.Add(Pages.GetPage(10, True).PageType)
PageTypeList.Add(Pages.GetPage(8, True).PageType)
Model.Page.SubPagesByType(PageTypeList)
Liefert alle Shapes die in der Seite enthalten sind
Model.Page.GetShapes(Scope:=[Enum].Scope.Page)
Liefert alle Shapes vom gegebenen Typ
Model.Page.GetShapesByTypeName(Shapetype.Name,true)
Liefert alle Shapes der gegebenen Typen
Liefert ein Attribut der Page
Model.Page.GetAttributeValue("PageName", true)
Liefert alle Attribute der Page
Model.Page.GetAttributeValues()
Liefert ein Datumsattribut der Page (Ein Objekt vom Typ iTypedDate)
Model.Page.GetDateAttributeValue("Date1", true)
Liefert ein Dateiattribut der Page (Ein Objekt vom Typ iTypedFile)
Model.Page.GetFileAttributeValue("File1", true)
Liefert ein Bildattribut der Page (Ein Objekt vom Typ iTypedImage)
Model.Page.GetImageAttributeValue("Image1", true)
Liefert ein Link-Attribut der Page (Ein Objekt vom Typ iTypedLink)
Model.Page.GetLinkAttributeValue("Link1", true)
Liefert ein Textattribut der Page (Ein Objekt vom Typ iTypedText)
Model.Page.GetTextAttributeValue("Text1", true)
Liefert ein Integer-Attribut der Page (Ein Objekt vom Typ iTypedInteger)
Model.Page.GetIntegerAttributeValue("Integer1", true)
Liefert ein Integer-Attribut der Page
Liefert den Attribute Booleanwert der Page (Ein Objekt vom Typ iTypedBoolean)
Page.GetBooleanAttributeValue("Boolean1", true)
Liefert den Attribute Dropdown der Page (Ein Objekt vom Typ iTypedDropdown)
Model.Page.GetDropdownAttributeValue("Dropdown1", true)
Liefert den Attribute Dropdown der Page
Model.Page.GetDropdownAttributeValues("Dropdown1", true)
Liefert den Attribute Filewert der Page (Eine Liste von Objekten vom Typ iTypedFile)
Model.Page.GetFileAttributeValues("File1", true)
Liefert den Attribute Bildwert der Page (Eine Liste von Objekten vom Typ iTypedImage)
Model.Page.GetImageAttributeValues("Image1", true)
Liefert den Attribute Linkwert der Page (Eine Liste von Objekten vom Typ iTypedImage)
Model.Page.GetLinkAttributeValues("Link1", true)
Liefert den Attribute Textwert der Page (Eine Liste von Objekten vom Typ iTypedText)
Model.Page.GetTextAttributeValues("Text1", true)
Speichert ein Datumsattribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert.
Model.Page.SetDateAttributeValue("MyAttr", Date.Now, CurrentUser)
Speichert ein Boolean-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert.
Model.Page.SetBooleanAttributeValue("MyAttr", False, CurrentUser)
Speichert ein Dropdown-Attribut der Seite.
Ist ein Wert (NewValue) im Dropdown bereits gewählt, wird er nicht erneut hinzugefügt und "NoChanges" zurückgegeben.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert.
Model.Page.SetDropdownAttributeValue("MyAttr", "Optionswert", CurrentUser)
Setzt mehrere Dropdown-Attribute der Page
Model.Page.SetDropdownAttributeValues("MyAttr", "Optionswert", CurrentUser)
Speichert ein Text-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert.
Model.Page.SetTextAttributeValue("MyAttr", "Text", CurrentUser)
Speichert ein Integer-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert. Ebenso wird "Failed" geliefert, wenn die in der Config angegebene Schrittweite "Step" nicht zu NewValue passt.
Model.Page.SetIntegerAttributeValue("MyAttr", 5, CurrentUser)
Speichert ein Decimal-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert. Ebenso wird "Failed" geliefert, wenn die in der Config angegebene Schrittweite "Step" nicht zu NewValue passt.
Model.Page.SetDecimalAttributeValue("MyAttr", 2.6, CurrentUser)
Speichert ein File-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert. Gibt es keine Datei zur gegebenen ID wird "Invalid Value" geliefert.
Model.Page.SetFileAttributeValue("MyAttr", MyFile, CurrentUser)
Speichert mehrere Werte in ein File-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert. Gibt es keine Datei zur gegebenen ID wird "Invalid Value" geliefert.
Schlägt der Speichervorgang bei einem einzelnen Attribut fehl, wird als Gesamtstatus "Failed" geliefert. Alle Attribute, die angelegt werden können, werden dennoch normal erstellt.
Model.Page.SetFileAttributeValues("MyAttr", New List(Of iFile) From {Files.GetByID(1, True),Files.GetByID(3, True),Files.GetByID(6, True),Files.GetByID(9, True)}, CurrentUser)
Setzt ein File-Attribut der Page für Multiple-Attribut
Model.Page.SetMultipleFileAttributeValue("myAttr", myTargetFile, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert ein Image-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert. Gibt es keine Datei zur gegebenen ID wird "Invalid Value" geliefert.
Model.Page.SetImageAttributeValue("MyAttr", MyFile, CurrentUser)
Speichert mehrere Werte in ein Image-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert oder es keine Datei zur gegebenen ID gibt.
Schlägt der Speichervorgang bei einem einzelnen Attribut fehl, wird als Gesamtstatus "Failed" geliefert. Alle Attribute, die angelegt werden können, werden dennoch normal erstellt.
Model.Page.SetImageAttributeValues("MyAttr", New List(Of iFile) From {Files.GetByID(1, True),Files.GetByID(3, True),Files.GetByID(6, True),Files.GetByID(9, True)}, CurrentUser)
Setzt ein Image-Attribut der Page für Multiple-Attribut
Speichert einen internen Link mit einer Seite als Ziel in ein Link-Attribut der Seite.
Ist der Name leer, ungültig, oder die Zielseite ungültig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetLinkAttributeValue("myAttr", myTargetPage, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert einen zusätzlichen internen Link mit einer Seite als Ziel in ein Multiple-Link-Attribut der Seite.
Ist der Name leer, ungültig, oder die Zielseite ungültig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetMultipleLinkAttributeValue("myAttr", myTargetPage, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert einen internen Link mit einem Shape als Ziel in ein Link-Attribut der Seite.
Ist der Name leer, ungültig, oder das Zielshape ungültig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetLinkAttributeValue("myAttr", myTargetShape, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert einen zusätzlichen internen Link mit einem Shape als Ziel in ein Multiple-Link-Attribut der Seite.
Ist der Name leer, ungültig, oder das Zielshape ungültig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetMultipleLinkAttributeValue("myAttr", myTargetShape, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert einen Link mit einer Datei als Ziel in ein Link-Attribut der Seite.
Ist der Name leer, ungültig, oder die Zieldatei ungültig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetLinkAttributeValue("myAttr", myTargetFile, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert einen zusätzlichen Link mit einer Datei als Ziel in ein Multiple-Link-Attribut der Seite.
Ist der Name leer, ungültig, oder die Zieldatei ungültig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetMultipleLinkAttributeValue("myAttr", myTargetFile, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert einen Mail-Link in ein Link-Attribut der Seite.
Ist der Name leer, ungültig, oder die Mail syntaktisch nicht zulässig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetLinkAttributeValue("myAttr", "test@test.test", "Hierhin führt der Link", "Hier klicken", False, "Mein Betreff" CurrentUser)
Speichert einen zusätzlichen Mail-Link in ein Multiple-Link-Attribut der Seite.
Ist der Name leer, ungültig, oder die Mail syntaktisch nicht zulässig, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Model.Page.SetMultipleLinkAttributeValue("myAttr", "test@test.test", "Hierhin führt der Link", "Hier klicken", False, "Mein Betreff", CurrentUser)
Speichert einen externen Link in ein Link-Attribut der Seite. Die Angabe von http:// oder https:// ist möglich, aber optional, das passende Protokoll wird automatisch hinzugefügt, wenn es fehlt. Es findet eine Erkennung statt, ob https://n möglich ist, wenn ja, wird dies verwendet ansonsten http://. Ob die URL erreichbar ist und ob es sich um eine Weiterleitung handelt, kann im Result ermittelt werden.
Ist der Name leer, ungültig, oder die URL nicht aufrufbar, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Der Status der URL-Validierung (Permanent Redirect, TemporaryRedirect, usw.) können über das LinkCheckResult des Rückgabeobjekts abgefragt werden.
Model.Page.SetLinkAttributeValue("myAttr", "https://www.procomp.de", "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Speichert einen externen Link in ein Link-Multiple-Attribut der Seite. Die Angabe von http:// oder https:// ist möglich, aber optional, das passende Protokoll wird automatisch hinzugefügt, wenn es fehlt. Es findet eine Erkennung statt, ob https://n möglich ist, wenn ja, wird dies verwendet ansonsten http://. Ob die URL erreichbar ist und ob es sich um eine Weiterleitung handelt, kann im Result ermittelt werden.
Ist der Name leer, ungültig, oder die URL nicht aufrufbar, wird "InvalidValue" geliefert.
Sind im Attribut bestimmte Eigenschaften des Links (Title, Text, etc.) über die Config deaktiviert, werden diese Werte leer übernommen, unabhängig vom angegebenen Wert.
Der Status der URL-Validierung (Permanent Redirect, TemporaryRedirect, usw.) können über das LinkCheckResult des Rückgabeobjekts abgefragt werden.
Model.Page.SetMultipleLinkAttributeValue("myAttr", "https://www.procomp.de", "Hierhin führt der Link", "Hier klicken", False, CurrentUser)
Ändert den Namen der Seite. Dadurch wird auch die URL der Seite neu generiert, sofern diese keine Custom-URL ist.
Model.Page.SetName("Neuer Name", CurrentUser)
Ändert die Meta-Beschreibung der Seite. Diese darf auch leer sein.
Model.Page.SetMetaDescription("Hier steht Ihre Beschreibung", CurrentUser)
Ändert die Meta-Keywords der Seite. Diese dürfen auch leer sein.
Model.Page.SetMetaKeywords("Seite, Page, Web, Webseite, Website", CurrentUser)
Fügt der Seite eine alternative URL an (301-Weiterleitung).
Wird eine URL hinzugefügt, die einer vorhandenen primären URL entspricht, wird "AlreadyExists" geliefert.
Existiert die URL bereits als Weiterleitung oder als Gone-URL (Status 410), wird die bestehende überschrieben.
Model.Page.AddAlternativeURL("myAlternative", CurrentUser)
Gibt diejenige Seite in der Zielsprache zurück, die den engsten Bezug zu dieser Seite hat.
Die Enge des Bezugs ist wie folgt geregelt:
0 Verknüpfung vorhanden -> Verknüpfung liefern
0* Verknüpfung nicht vorhanden -> 1
1 Parent verknüpft -> 2
2 Seite unterhalb der Verknüpfung des Parents auf gleichem Rank vorhanden -> 3
3 Seite ist vom gleichen Typ -> liefern
3* Seite ist nicht vom gleichen Typ -> 4
2* Keine Seite unterhalb der Verknüpfung des Parents auf gleichem Rank vorhanden
4 Es gibt in der Zielebene eine Seite gleichen Typs (rekursiv nach unten) -> Die näheste liefern
4* Es gibt in der Zielebene keine Seite gleichen Typs oder gar keine Seite -> 5
1* Parent nicht verknüpft -> 5
5 ParentID = 0 -> 6
6 Eine Seite gleichen Typs in der gleichen Navigation vorhanden -> Erste liefern
6* Keine Seite gleichen Typs in der gleichen Navigation vorhanden -> 7
7 Eine Seite des gleichen Typs in der ganzen Struktur vorhanden -> Erste liefern
7* Keine Seite des gleichen Typs vorhanden -> 8
5* ParentID > 0 -> 1 ausgehend vom Parent
8 Es gibt eine Seite in der gleichen Navigation -> erste liefern
8* Es gibt keine Seite in der gleichen Navigation -> 9
9 Es gibt eine Startseite -> diese liefern
9* Es gibt keine Startseite -> NOTHING
Model.Page.ClosestEquivalent(2)
Gibt die Seite zurück, mit der die Seite in der Sprache mit TargetLanguageID verknüpft ist.
Gibt es keine, wird ein ungültiges Objekt geliefert.
Model.Page.Equivalent(2)
Prüft, ob der übergebene Name dem des Pagetypen entspricht.
Prüft, ob einer der übergebenen Typen dem der Seite entspricht.
Folgende zwei Schreibweisen bewirken das Selbe:
MyPage.IsOfType("apfel") OrElse MyPage.IsOfType("banane")
MyPage.IsOfType({"apfel", "banane"})
Prüft, ob der übergebene Typ dem der Seite entspricht.
Prüft, ob einer der übergebenen Typen dem der Seite entspricht.
Ändert die Überschrift der Seite in den Wert von NewHeadline (dazu wird auch ein Änderungseintrag im Verlauf der Seite erzeugt)
Model.Page.SetHeadline("Neue Überschrift", CurrentUser)
Führt einen Check-In der Seite aus, d.h. andere Benutzer können diese nun wieder bearbeiten.
Model.Page.CheckIn(CurrentUser)
Veröffentlicht den aktuellen Stand der Seite.
Model.Page.Publish(CurrentUser)
Entfernt die Veröffentlichung der Seite.
Model.Page.UnPublish(CurrentUser)
Führt einen Check-Out der Seite durch die gegebene Person durch
Model.Page.CheckOut(CurrentUser)
Löscht eine Seite. Ihre URL liefert im Anschluss ohne Angabe von RedirectPage HTTP-Status 410, wenn sie bereits veröffentlicht war, ansonsten 404.
Wenn RedirectPage angegeben ist und gültig ist, verweist ihre URL anschließend auf die URL dieser Seite mit Status 301. So können URLs weiter aufrufbar gehalten werden.
' Löschung mit Weiterleitung zur Startseite
MyPage.Delete(CurrentUser, RedirectPage:=API.Pages.GetStartPage(MyLanguageID, True))
Liefert eine Liste aller alternativer URLs der Seite
Setzt die alternative URL auf "Gone", d.h. sie leifert nach dieser Aktion HTTP-Status 410.
Model.Page.SetAlternativeURLToGone(myAlternativeURL, CurrentUser)
Weist die Benutzergruppe der Seite zu.
Der Modifier muss entweder selbst in der Gruppe sein oder alle beinhalteten Rechte besitzen.
Damit diese Funktion genutzt werden kann muss die Einstellung "Benutzerverwaltung über die API erlauben" aktiviert sein.
Prüft, ob die Seite in der Sprache ein gegenstück hat
Liefert die Seite, welche der Übergebenen in der Sprache am ähnlichsten ist