Hilfe-Center

iPage

iPage ist eine der zentralen Klassen im System; Sie repräsentiert eine Seite.

ReadOnly Property ID As Integer

Liefert die ID der Page

Copy

Model.Page.ID

ReadOnly Property Name As String

Liefert den Namen der Page

Copy

Model.Page.Name

ReadOnly Property Title As String

Liefert den Titel der Page

Copy

Model.Page.Title

ReadOnly Property MetaKeywords As String

Liefert die MetaKeywords der Page

Copy

Model.Page.MetaKeywords

ReadOnly Property MetaDescription As String

Liefert die MetaDescription der Page

Copy

Model.Page.MetaDescription

ReadOnly Property Active As Boolean

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!

Copy

Model.Page.Active

ReadOnly Property IsLoginRequired As Boolean

Gibt true zurück wenn die Page durch einen Login geschützt ist, false wenn nicht.

Copy

Model.Page.IsLoginRequired

ReadOnly Property IsVisible As Boolean

Gibt true zurück wenn die Page sichtbar ist, false wenn nicht

Copy

Model.Page.IsVisible

ReadOnly Property IsVisibilityChangeable As Boolean [V2]

Gibt true zurück ob die Sichtbarkeit der Seite geändert werden darf

Copy

Model.Page.IsChangeable

ReadOnly Property IsDeletable As Boolean

Gibt true zurück wenn die Seite gelöscht werden darf

Copy

Model.Page.IsDeletable

ReadOnly Property NoIndex As Boolean

Gibt true zurück wenn die Seite mit einem NoIndex Tag versehen werden soll.

Copy

Model.Page.NoIndex

ReadOnly Property Rank as Integer

Liefert die Position der Page

Copy

Model.Page.Rank

ReadOnly Property Language As iLanguage [V2]

Liefert die SprachenID der Page

Copy

Model.Page.LanguageID

Copy

Model.Page.NavigationID

ReadOnly Property Headline As String

Liefert die H1 der Page

Copy

Model.Page.Headline

ReadOnly Property Version As Integer

Liefert die Version des Datensatzes. Pro Änderung an einem Objekt wird die Version erhöht.

Copy

Model.Page.Version

ReadOnly Property CreatedOn As Date [V2]

Liefert das Datum wann die Page erstellt wurde

Copy

Model.Page.CreatedOn

ReadOnly Property Creator As iAdministrator [V2]

Liefert den Administrator der die Page erstellt hat

Copy

Model.Page.Creator

ReadOnly Property ModifiedOn As Date [V2]

Liefert das Datum wann die Page das letzte mal geändert wurde.

ReadOnly Property Modifier As iAdministrator [V2]

Liefert den Administrator der die Page als letztes geändert hat.

ReadOnly Property LastPublished As Date [V2]

Gibt den Zeitpunkt der neuesten Publish-Aktion an.

ReadOnly Property HasSubPages As Boolean

Liefert true wenn es Unterseiten gibt, false wenn nicht

Copy

Model.Page.HasSubPages

ReadOnly Property HasEverBeenPublished As Boolean

true, falls die Seite jemals veröffentlicht wurde.

Copy

Model.Page.HasEverBeenPublished

ReadOnly Property IsFirstLevel As Boolean

Liefert true wenn es eine Seite auf der ersten Ebene ist, false wenn nicht

Copy

Model.Page.IsFirstLevel

ReadOnly Property Parent As iPage

Liefert das Elternelement als Objekt vom Typ iPage

Copy

Model.Page.Parent

ReadOnly Property PreviousPage As iPage

Liefert aus der Liste der selben Ebene die vorherige Page

Copy

Model.Page.PreviousPage

ReadOnly Property NextPage As iPage

Liefert aus der Liste der selben Ebene die nächste Page

Copy

Model.Page.NextPage

ReadOnly Property URL as iURL

Liefert die URL der Page

Copy

Model.Page.URL

ReadOnly Property PageType As iPageType

Liefert den Page Typen der Page

Copy

Model.Page.PageType

ReadOnly Property TreeLevel as Integer

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.

Copy

Model.Page.TreeLevel

ReadOnly Property Path(
Optional Separator as String "-", Optional WithPageName As Boolean = False) As HtmlString

Liefert den Pfad der Page

  • Optionale Parameter:
  • Separator: Optionaler Parameter als String um den Pfad mit einen bestimmten Trennzeichen zu Trennen
  • WithPageName: Optionaler Parameter als Booleanwert. Hängt den aktuellen Seitennamen an den Pfad wenn true, Standardwert ist false und hängt den Seitennamen nicht mit an
Copy

Model.Page.Path(" <i class=""cico cico-caret-right-b""></i> ", True)

ReadOnly Property IsOrContains(Page As iPage) As Boolean [V2]

Liefert true wenn die Page die übergeben wird er selbst ist oder als Unterseite enthalten ist

Copy

Model.Page.IsOrContains(22)

ReadOnly Property IsCheckedOut As Boolean

Gibt an, ob die Seite derzeit von einem Administrator oder Benutzer zur Bearbeitung ausgecheckt ist

Copy

Model.Page.IsCheckedOut

Function SubPages(
Optional WithInvisible As Boolean = False,
Optional UserID As Integer = 0
) As iEnumerable(Of iPage) [V2]

Liefert alle Unterseiten der ersten Ebene

Copy

Model.Page.SubPages()

SubPages(
PageType As iPageType,
Optional WithInvisible As Boolean = False,
Optional UserID As Integer = 0
) As iEnumerable(Of iPage) [V2]

Liefert alle Unterseiten als iPage-Liste anhand eines PageTypes.

SubPages(
PageTypes As iEnumerable(Of iPage),
Optional WithInvisible As Boolean = False,
Optional UserID As Integer = 0
) As iEnumerable(Of iPage) [V2]

Liefert alle Unterseiten als iPage-Liste anhand der Liste von PageTypes.

SubPagesRecursive(
 Optional UserID As Integer = 0
) As iEnumerable(Of iPage) [V2]

Liefert alle Unterseiten rekursiv als iPage-Liste.

  • Optionale Parameter:
  • UserID: Das Ergebnis auf einen bestimmten Benutzer einschränken, der Zugriffsrechte auf die Seite besitzt

Function SubPagesByType(
Type As iPageType,
Optional ExcludeType As Boolean = False,
Optional WithInvisible As Boolean = True,
Optional UserID As Integer = 0,
Optional Recursive As Boolean = False
) As iEnumerable(Of iPage) [V2]

Function SubPagesByType(Type As iPageType, Optional ExcludeType As Boolean = False, Optional WithInactive As Boolean = False, Optional WithInvisible As Boolean = True) As List(Of iPage)

  • Type: PageType nach der die Liste gefiltert werden soll
  • Optionale Parameter:
    • ExcludeType: Wird dieser Parameter mit True angegeben, wird der angegebene Seitentyp als auszuschließen angesehen. Das heißt, es werden alle Unterseiten geliefert, die NICHT diesem Typ entsprechen.
    • WithInvisible: Falls False, werden im Menü nicht sichtbare Seite ausgeschlossen.
    • UserID: Das Ergebnis auf einen bestimmten Benutzer einschränken, der Zugriffsrechte auf die Seite besitzt
    • Recursive: Seiten rekursiv suchen
Copy

Model.Page.SubPagesByType(Pages.GetPage(10, True).PageType)

Function SubPagesByType(
TypeList As List(Of iPageType),
Optional ExcludeType As Boolean = False,
Optional WithInvisible As Boolean = True,
Optional UserID As Integer = 0,
Optional Recursive As Boolean = False
) As List(Of iPage)

Liefert alle Unterseiten eines bestimmten Typs. Standardmäßig werden alle Unterseiten des gegebenen Typs ohne inaktive Seiten geliefert.

  • TypeList: Liste von PageTypes nach denen die Liste gefiltert werden soll
  • Optionale Parameter:
    • ExcludeType: Wird dieser Parameter mit True angegeben, wird der angegebene Seitentyp als auszuschließen angesehen. Das heißt, es werden alle Unterseiten geliefert, die NICHT diesem Typ entsprechen.
    • WithInvisible: Falls False, werden im Menü nicht sichtbare Seite ausgeschlossen.
    • UserID: Das Ergebnis auf einen bestimmten Benutzer einschränken, der Zugriffsrechte auf die Seite besitzt
    • Recursive: Seiten rekursiv suchen
Copy

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)

Function GetShapes(
Optional Scope As Content.[Enum].Scope = Content.[Enum].Scope.Page,
Optional ShapeArea As String = ""
) As IEnumerable(Of iShape) [V2]

Liefert alle Shapes die in der Seite enthalten sind

  • Optionale Parameter
    • Scope: Anzeigebereich der Shapes
    • ShapeArea:  Nur Shapes in der gegebenen Area liefern
Copy

Model.Page.GetShapes(Scope:=[Enum].Scope.Page)

Function GetShapesByTypeName(TypeName As String, EditMode As Boolean) As IEnumerable(Of iShape)

Liefert alle Shapes vom gegebenen Typ

  • TypeName: Shape Typen Name nach welchem die Suche gefiltert werden soll
  • EditMode: Gibt an ob die Shapes aus dem veröffentlichten Stand oder dem Bearbeitungsstand geholt werden sollen
Copy

Model.Page.GetShapesByTypeName(Shapetype.Name,true)

Function GetShapesByTypeName(
TypeNames As IEnumerable(Of String),
EditMode As Boolean
) As IEnumerable(Of iShape) [V2]

Liefert alle Shapes der gegebenen Typen

  • TypeNames: Liste von Shape Typen Name nach welchen die Suche gefiltert werden sollen
  • EditMode: Gibt an ob die Shapes aus dem veröffentlichten Stand oder dem Bearbeitungsstand geholt werden sollen

Function GetAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iAttributeValue

Liefert ein Attribut der Page

  • Name: Name des Attributs
  • EditMode: Vom TemplateViewModel übertragen
  • Optionale Parameter
    • Rank: Gibt die Position des Attributes an
Copy

Model.Page.GetAttributeValue("PageName", true)

Function GetAttributeValues() As List(Of iAttributeValue)

Liefert alle Attribute der Page

Copy

Model.Page.GetAttributeValues()

Function GetDateAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = <1>) As iTypedDate

Liefert ein Datumsattribut der Page (Ein Objekt vom Typ iTypedDate)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank: Rank als Positionsangabe des Attributes
Copy

Model.Page.GetDateAttributeValue("Date1", true)

Function GetFileAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedFile

Liefert ein Dateiattribut der Page (Ein Objekt vom Typ iTypedFile)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionaler Parameter
    • Rank: Rank als Positionsangabe des Attributes
Copy

Model.Page.GetFileAttributeValue("File1", true)

Function GetImageAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedImage

Liefert ein Bildattribut der Page  (Ein Objekt vom Typ iTypedImage)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank: Rank als Positionsangabe des Attributes
Copy

Model.Page.GetImageAttributeValue("Image1", true)

Function GetLinkAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedLink

Liefert ein Link-Attribut der Page (Ein Objekt vom Typ iTypedLink)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank: Optionaler Parameter Rank als Positionsangabe des Attributes
Copy

Model.Page.GetLinkAttributeValue("Link1", true)

Function GetTextAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedText

Liefert ein Textattribut der Page (Ein Objekt vom Typ iTypedText)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank: Rank als Positionsangabe des Attributes
Copy

Model.Page.GetTextAttributeValue("Text1", true)

Function GetIntegerAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedInteger

Liefert ein Integer-Attribut der Page (Ein Objekt vom Typ iTypedInteger)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank: Rank als Positionsangabe des Attributes
Copy

Model.Page.GetIntegerAttributeValue("Integer1", true)

Function GetDecimalAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedDecimal

Liefert ein Integer-Attribut der Page

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank: Optionaler Parameter Rank als Positionsangabe des Attributes

Function GetBooleanAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedBoolean

Liefert den Attribute Booleanwert der Page (Ein Objekt vom Typ iTypedBoolean)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank: Rank als Positionsangabe des Attributes
Copy

Page.GetBooleanAttributeValue("Boolean1", true)

Function GetDropdownAttributeValue(Name As String, EditMode As Boolean, Optional Rank As Integer = 1) As iTypedDropdown

Liefert den Attribute Dropdown der Page (Ein Objekt vom Typ iTypedDropdown)

  • Name: Name des Attributes
  • EditMode: Editmode
  • Optionale Parameter:
    • Rank:  Rank als Positionsangabe des Attributes
Copy

Model.Page.GetDropdownAttributeValue("Dropdown1", true)

Function GetDropdownAttributeValues(Name As String, EditMode As Boolean) As IEnumerable(Of iTypedDropdown)

Liefert den Attribute Dropdown der Page

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Page.GetDropdownAttributeValues("Dropdown1", true)

Function GetFileAttributeValues(Name As String, EditMode As Boolean) As IEnumerable(Of iTypedFile)

Liefert den Attribute Filewert der Page (Eine Liste von Objekten vom Typ iTypedFile)

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Page.GetFileAttributeValues("File1", true)

Function GetImageAttributeValues(Name As String, EditMode As Boolean) As IEnumerable(Of iTypedImage)

Liefert den Attribute Bildwert der Page (Eine Liste von Objekten vom Typ iTypedImage)

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Page.GetImageAttributeValues("Image1", true)

Function GetLinkAttributeValues(Name As String, EditMode As Boolean) As IEnumerable(Of iTypedLink)

Liefert den Attribute Linkwert der Page (Eine Liste von Objekten vom Typ iTypedImage)

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Page.GetLinkAttributeValues("Link1", true)

Function GetTextAttributeValues(Name As String, EditMode As Boolean) As IEnumerable(Of iTypedText)

Liefert den Attribute Textwert der Page (Eine Liste von Objekten vom Typ iTypedText)

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Page.GetTextAttributeValues("Text1", true)

Function SetDateAttributeValue(
Name As String,
NewValue As Date,
Modifier As iPerson
) As SetAttributeResult

Speichert ein Datumsattribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetDateAttributeValue("MyAttr", Date.Now, CurrentUser)

Function SetBooleanAttributeValue(
Name As String,
NewValue As Boolean,
Modifier As iPerson
) As SetAttributeResult

Speichert ein Boolean-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetBooleanAttributeValue("MyAttr", False, CurrentUser)

Function SetDropdownAttributeValue(
Name As String,
NewValue As String,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetDropdownAttributeValue("MyAttr", "Optionswert", CurrentUser)

Function SetDropdownAttributeValues(
Name As String,
NewValues As IEnumerable(Of String),
Modifier As iPerson
 ) As SetMultipleAttributeResult

Setzt mehrere Dropdown-Attribute der Page

  • Name: Name des Attributs
  • NewValue: Werte welche das Attribut haben soll
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetDropdownAttributeValues("MyAttr", "Optionswert", CurrentUser)

Function SetTextAttributeValue(Name As String, NewValue As String, ModifierAs iPerson) As SetAttributeResult

Speichert ein Text-Attribut der Seite.
Es wird "Failed" geliefert, wenn der angegebene Attributname in der Seite nicht existiert.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetTextAttributeValue("MyAttr", "Text", CurrentUser)

Function SetIntegerAttributeValue(
Name As String,
NewValue As Integer,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetIntegerAttributeValue("MyAttr", 5, CurrentUser)

Function SetDecimalAttributeValue(
Name As String,
NewValue As Decimal,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetDecimalAttributeValue("MyAttr", 2.6, CurrentUser)

Function SetFileAttributeValue(
Name As String,
NewFile As iFile,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • NewFile: Der zu speichernde Wert
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetFileAttributeValue("MyAttr", MyFile, CurrentUser)

Function SetFileAttributeValues(
Name As String,
NewFiles As IEnumerable(Of iFile),
Modifier As iPerson
) As SetMultipleAttributeResult [V2]

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.

  • Name: Name des Attributs
  • NewFiles: Liste von Objekten der zu speichernden Dateien
  • Modifier:  Die ausführende Person
Copy

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)

Function SetMultipleFileAttributeValue(
Name As String,
NewFile As iFile,
Modifier As iPerson
) As SetMultipleAttributeResult

Setzt ein File-Attribut der Page für Multiple-Attribut

  • Name: Name des Attributs
  • NewFile: Datei welche in das Attribut gespeichert werden soll
  • Modifier: Person welche das Attribut speichert
Copy

Model.Page.SetMultipleFileAttributeValue("myAttr", myTargetFile, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetImageAttributeValue(
Name As String,
NewImage As iFile,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • NewImage: Das Objekt der zu speichernden Bilddatei
  • Modifier:  Die ausführende Person
Copy

Model.Page.SetImageAttributeValue("MyAttr", MyFile, CurrentUser)

Function SetImageAttributeValues(
Name As String,
NewImages As IEnumerable(Of iFile),
Modifier As iPerson
) As SetMultipleAttributeResult [V2]

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.

  • Name: Name des Attributs
  • NewImages: Liste von Objekten der zu speichernden Bilddateien
  • Modifier:  Die ausführende Person
Copy

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)

Function SetMultipleImageAttributeValue(
Name As String,
NewImage As iFile,
Modifier As iPerson
) As SetMultipleAttributeResult

Setzt ein Image-Attribut der Page für Multiple-Attribut

  • Name: Name des Attributs
  • NewImage: Bild welches in das Attribut gespeichert werden soll
  • Modifier:  Die ausführende Person

Function SetLinkAttributeValue(
Name As String,
TargetPage As iPage,
Title As String,
Text As String,
TargetBlank As Boolean,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • TargetPage: Die Zielseite
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Modifier: Die ausführende Person
Copy

Model.Page.SetLinkAttributeValue("myAttr", myTargetPage, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetMultipleLinkAttributeValue(
Name As String,
TargetPage As iPage,
Title As String,
Text As String,
TargetBlank As Boolean,
Modifier As iPerson
) As SetMultipleAttributeResult

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.

  • Name: Name des Attributs
  • TargetPage: Die Zielseite
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Modifier: Die ausführende Person
Copy

Model.Page.SetMultipleLinkAttributeValue("myAttr", myTargetPage, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetLinkAttributeValue(
Name As String,
TargetShape As iShape,
Title As String,
Text As String,
TargetBlank As Boolean,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • TargetShape: Das Zielshape
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Modifier: Die ausführende Person
Copy

Model.Page.SetLinkAttributeValue("myAttr", myTargetShape, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetMultipleLinkAttributeValue(
Name As String,
TargetShape As iShape,
Title As String,
Text As String,
TargetBlank As Boolean,
Modifier As iPerson
) As SetMultipleAttributeResult

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.

  • Name: Name des Attributs
  • TargetShape: Das Zielshape
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Modifier: Die ausführende Person
Copy

Model.Page.SetMultipleLinkAttributeValue("myAttr", myTargetShape, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetLinkAttributeValue(
Name As String,
TargetFile As iFile,
Title As String,
Text As String,
Attachment As Boolean,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • TargetFile: Die Zieldatei
  • Title: Titel des Links
  • Text: Der Text des Links
  • Attachment: Falls True, wird der Link als Direktdownload angelegt (Download startet bei Klick auf den Link sofort)
  • Modifier: Die ausführende Person
Copy

Model.Page.SetLinkAttributeValue("myAttr", myTargetFile, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetMultipleLinkAttributeValue(
Name As String,
TargetFile As iFile,
Title As String,
Text As String,
Attachment As Boolean,
Modifier As iPerson
) As SetMultipleAttributeResult

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.

  • Name: Name des Attributs
  • TargetFile: Die Zieldatei
  • Title: Titel des Links
  • Text: Der Text des Links
  • Attachment: Falls True, wird der Link als Direktdownload angelegt (Download startet bei Klick auf den Link sofort)
  • Modifier: Die ausführende Person
Copy

Model.Page.SetMultipleLinkAttributeValue("myAttr", myTargetFile, "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetLinkAttributeValue(
Name As String,
MailAddress As String,
Title As String,
Text As String,
TargetBlank As Boolean,
Subject As String,
Modifier As iPerson
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • MailAddress: Die Ziel-Mailadresse
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Subject: Der Betreff für die Mail
  • Modifier: Die ausführende Person
Copy

Model.Page.SetLinkAttributeValue("myAttr", "test@test.test", "Hierhin führt der Link", "Hier klicken", False, "Mein Betreff" CurrentUser)

Function SetMultipleLinkAttributeValue(
Name As String,
MailAddress As String,
Title As String,
Text As String,
TargetBlank As Boolean,
Subject As String,
Modifier As iPerson
) As SetMultipleAttributeResult

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.

  • Name: Name des Attributs
  • MailAddress: Die Ziel-Mailadresse
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Subject: Der Betreff für die Mail
  • Modifier: Die ausführende Person
Copy

Model.Page.SetMultipleLinkAttributeValue("myAttr", "test@test.test", "Hierhin führt der Link", "Hier klicken", False, "Mein Betreff", CurrentUser)

Function SetLinkAttributeValue(
Name As String,
URL As String,
Title As String,
Text As String,
TargetBlank As Boolean,
Modifier As iPerson,
Optional PreventValidation As Boolean = False
) As SetAttributeResult

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.

  • Name: Name des Attributs
  • URL: Die Ziel-URL des Links
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Modifier: Die ausführende Person
  • Optionale Parameter:
    • PreventValidation:  Wenn auf True gesetzt, kann der externe Link auf jeden Fall gespeichert werden und es findet keine Validierung statt (entspricht dem Haken "speichern erzwingen" im Link-Dialog)
Copy

Model.Page.SetLinkAttributeValue("myAttr", "https://www.procomp.de", "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetMultipleLinkAttributeValue(
Name As String,
NewValue As String,
Title As String,
Text As String,
TargetBlank As Boolean,
Modifier As iPerson,
Optional PreventValidation As Boolean = False
) As SetMultipleLinkResult

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.

  • Name: Name des Attributs
  • URL: Die Ziel-URL des Links
  • Title: Titel des Links
  • Text: Der Text des Links
  • TargetBlank: Falls True, wird der Link immer in einem neuen Tab geöffnet
  • Modifier: Die ausführende Person
  • Optionale Parameter:
    • PreventValidation:  Wenn auf True gesetzt, kann der externe Link auf jeden Fall gespeichert werden und es findet keine Validierung statt (entspricht dem Haken "speichern erzwingen" im Link-Dialog)
Copy

Model.Page.SetMultipleLinkAttributeValue("myAttr", "https://www.procomp.de", "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

Function SetName(NewValue As String, Modifier As iPerson) As API.Enum.SaveResult

Ändert den Namen der Seite. Dadurch wird auch die URL der Seite neu generiert, sofern diese keine Custom-URL ist.

  • NewValue: Der neue Name
  • Modifier: Die ausführende Person
Copy

Model.Page.SetName("Neuer Name", CurrentUser)

Function SetMetaDescription(NewValue As String, Modifier As iPerson) As API.Enum.SaveResult

Ändert die Meta-Beschreibung der Seite. Diese darf auch leer sein.

  • NewValue: Die neue Meta-Beschreibung
  • Modifier: Die ausführende Person
Copy

Model.Page.SetMetaDescription("Hier steht Ihre Beschreibung", CurrentUser)

Function SetMetaKeywords(NewValue As String, Modifier As iPerson) As API.Enum.SaveResult

Ändert die Meta-Keywords der Seite. Diese dürfen auch leer sein.

  • NewValue: Die neuen Meta-Keywords
  • Modifier: Die ausführende Person
Copy

Model.Page.SetMetaKeywords("Seite, Page, Web, Webseite, Website", CurrentUser)

Function AddAlternativeURL(
NewURL As String,
Modifier As iPerson,
Optional NewURLMapping As iURLMapping = Nothing
) As API.Enum.SaveResult

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.

  • NewURL: die neue, alternative URL
  • Modifier: die ausführende Person
  • Optionale Parameter
    • NewURLMapping: das Mapping der neuen URL, wenn nicht angegeben, dann wird das aktuelle der Seite verwendet
Copy

Model.Page.AddAlternativeURL("myAlternative", CurrentUser)

Function ClosestEquivalent(TargetLanguageID As Integer) As iPage [V2]

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

 

  • TargetLanguageID: ID der Sprache der Zielseite
Copy

Model.Page.ClosestEquivalent(2)

Function Equivalent(TargetLanguageID As Integer) as iPage [V2]

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.

  • TargetLanguageID: ID der Sprache der Zielseite
Copy

Model.Page.Equivalent(2)

Function IsOfType(PageTypeName As String, Optional RaiseException As Boolean = False) As Boolean

Prüft, ob der übergebene Name dem des Pagetypen entspricht.

Function IsOfType(
PageTypeNames As IEnumerable(Of String),
Optional RaiseException As Boolean = False
) As Boolean [V2]

Prüft, ob einer der übergebenen Typen dem der Seite entspricht.

Folgende zwei Schreibweisen bewirken das Selbe:

Copy

MyPage.IsOfType("apfel") OrElse MyPage.IsOfType("banane")

MyPage.IsOfType({"apfel", "banane"})

Function IsOfType(PageType As iPageType, Optional RaiseException As Boolean = False) As Boolean [V2]

Prüft, ob der übergebene Typ dem der Seite entspricht.

Function IsOfType(
PageTypes As IEnumerable(Of iPageType),
Optional RaiseException As Boolean = False
) As Boolean [V2]

Prüft, ob einer der übergebenen Typen dem der Seite entspricht.

Function SetHeadline(NewHeadline As String, Modifier As iPerson) As API.Enum.SaveResult [V2]

Ändert die Überschrift der Seite in den Wert von NewHeadline (dazu wird auch ein Änderungseintrag im Verlauf der Seite erzeugt)

Copy

Model.Page.SetHeadline("Neue Überschrift", CurrentUser)

Function CheckIn(Modifier As iPerson) As API.Enum.SaveResult [V2]

Führt einen Check-In der Seite aus, d.h. andere Benutzer können diese nun wieder bearbeiten.

Copy

Model.Page.CheckIn(CurrentUser)

Function Publish(Modifier As iPerson) As API.Enum.SaveResult [V2]

Veröffentlicht den aktuellen Stand der Seite.

Copy

Model.Page.Publish(CurrentUser)

Function UnPublish(Modifier As iPerson) As API.Enum.SaveResult

Entfernt die Veröffentlichung der Seite.

Copy

Model.Page.UnPublish(CurrentUser)

Function CheckOut(Modifier As iPerson) As API.Enum.SaveResult [V2]

Führt einen Check-Out der Seite durch die gegebene Person durch

Copy

Model.Page.CheckOut(CurrentUser)

Function Delete(Modifier As iPerson, Optional RedirectPage As iPage = Nothing) As API.Enum.DeleteResult

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.

  • Modifier: die ausführende Person
  • Optionale Parameter
    • RedirectPage: die Seite, auf die die URL ab jetzt verweisen soll; Wenn angegeben bleibt die URL, wenn auch mit anderem Ziel, erreichbar
Copy

' Löschung mit Weiterleitung zur Startseite
MyPage.Delete(CurrentUser, RedirectPage:=API.Pages.GetStartPage(MyLanguageID, True))

Function GetAlternativeURLs() As IEnumerable(Of iURL)

Liefert eine Liste aller alternativer URLs der Seite

Function SetAlternativeURLToGone(URLToDelete As iURL, Modifier As iPerson) As SaveResult

Setzt die alternative URL auf "Gone", d.h. sie leifert nach dieser Aktion HTTP-Status 410.

  • URLToDelete: die zu entfernende, alternative URL
  • Modifier: die ausführende Person
Copy

Model.Page.SetAlternativeURLToGone(myAlternativeURL, CurrentUser)

Function AddPersonGroup(PersonGroupToAdd As iPersonGroup, Modifier As iPerson) As API.Enum.SaveResult

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.

Function HasEquivalent(TargetLanguage As iLanguage) As Boolean

Prüft, ob die Seite in der Sprache ein gegenstück hat

Function Equivalent(TargetLanguage As iLanguage) As iPage

Liefert die Seite, welche der Übergebenen in der Sprache am ähnlichsten ist

  • TargetLanguage: Sprache in der gesucht wird
War dieser Beitrag hilfreich?
0 von 0 fanden dies hilfreich.
Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.