Hilfe-Center
  1. Startseite
  2. Technische Referenz
  3. API
  4. API-Funktionen
  5. Shapes

Shapes

Beinhaltet alle shapebezogenen Funktionen, die keinem speziellen Shape zugeordnet werden können.

Function GetByID(ID As Integer, EditMode As Boolean) As iShape

Liefert ein iShape anhand der ID des Shapes

Copy

API.Shapes.GetByID(1, True)

Public Shared Function GetAllWebsiteShapes(EditMode As Boolean) As IEnumerable(Of iShape) [V2]

Liefert alle Shapes des Webseitenbereichs, gefiltert nach Sprache und EditMode

Copy

API.Shapes.GetAllWebsiteShapes(True)

GetByType(
    Type As iShapeType,
    EditMode As Boolean,
    Optional Language As iLanguage = Nothing
) As IEnumerable(Of iShape) [V2]

Liefert alle iShapes eines bestimmten Typs.

Shapes welche im Clipboard (ausgeschnitten) sind werden nicht mit geliefert.

  • Type: Das Objekt des ShapeTypes nach dem gesucht werden soll
  • EditMode: Sollen die Inhalte im ViewMode oder im EditMode geliefert werden
  • Optionale Parameter
    • Language: Objekt der Sprache auf die eingeschränkt werden soll, Wenn nicht angegeben, werden alle Sprachen genommen
Copy

API.Shapes.GetByType(API.ShapeTypes.GetByName("Paragraph"), True)

GetByType(
    Types As IEnumerable(Of iShapeType),
    EditMode As Boolean,
    Optional Language As iLanguage = Nothing
) As IEnumerable(Of iShape) [V2]

Liefert alle iShapes einer Liste von Types.

Shapes welche im Clipboard (ausgeschnitten) sind werden nicht mit geliefert.

  • Types: Eine Liste der ShapeTypes nach denen gesucht werden soll
  • EditMode: Sollen die Inhalte im ViewMode oder im EditMode geliefert werden
  • Optionale Parameter
    • Language: Objekt der Sprache auf die eingeschränkt werden soll, Wenn nicht angegeben, werden alle Sprachen genommen
Copy

API.Shapes.GetByType({API.ShapeTypes.GetByName("Paragraph"), API.ShapeTypes.GetByName("Slider")}, True)

Create(
    Parent As iShape,
    Type As iShapeType,
    ShapeArea As String,
    Modifier As iPerson,
    Optional Name As String = Nothing,
    Optional Rank As Integer = 0
) As ShapeCreateResult [V2]

Legt ein Shape innerhalb eines Shapes an.
Das Anlegen liefert im Status des Rückgabe-Objekts Failed, wenn das Shape an der gewünschten Stelle nicht erlaubt ist.

  • Parent: Das Elternshape des neuen Shapes
  • Type: Der Typ des neuen Shapes
  • ShapeArea: Die Shape-Area des neuen Shapes
    ACHTUNG: Shape-Areas können vom System nicht validiert werden - es ist sicherzustellen, dass der Name zum Template passt, ansonsten wird das Shape nicht angezeigt - an einer Lösung wird gearbeitet.
  • Modifier: Objekt der Person, die den Eintrag erstellt
  • Optionale Parameter
    • Name: Name des Shapes (zur Bildeung der Anker-URL), Ist kein Name angegeben wird der Name des Shapetypen mit einer fortlaufenden Zahl verwendet.
    • Rank: Rang des neuen Shapes. Ist er nicht gültig (also negativ oder größer als die Anzahl bestehender Unterelemente + 1), wird an letzter Stelle eingefügt
Copy

API.Shapes.Create(MyParentShape, MyType, "Content", CurrentUser, Name:="Mein Shape", Rank:=42)

Create(
    Parent As iPage,
    Type As iShapeType,
    ShapeArea As String,
    Modifier As iPerson,
    Optional Name As String = Nothing,
    Optional Rank As Integer = 0
) As ShapeCreateResult [V2]

Legt ein Shape innerhalb einer Seite an.
Das Anlegen liefert im Status des Rückgabe-Objekts Failed, wenn das Shape an der gewünschten Stelle nicht erlaubt ist.
Ist ein benötigter Parameter nicht gültig, wird "InvalidValue" geliefert.

  • Parent: Die Elternseite des neuen Shapes
  • Type: Der Typ des neuen Shapes
  • ShapeArea: die Shape-Area des neuen Shapes
    ACHTUNG: Shape-Areas können vom System nicht validiert werden - es ist sicherzustellen, dass der Name zum Template passt, ansonsten wird das Shape nicht angezeigt - an einer Lösung wird gearbeitet.
  • Modifier: Objekt der Person, die den Eintrag erstellt
  • Optionale Parameter
    • Name: Name des Shapes (zur Bildeung der Anker-URL), Ist kein Name angegeben wird der Name des Shapetypen mit einer fortlaufenden Zahl verwendet.
    • Rank: Rang des neuen Shapes. Ist er nicht gültig (also negativ oder größer als die Anzahl bestehender Unterelemente + 1), wird an letzter Stelle eingefügt
Copy

API.Shapes.Create(Model.Page, MyType, "Content", CurrentUser, Name:="Mein Shape", Rank:=42)

CreateWebsiteShape(
    EditPage As iPage,
    Type As iShapeType,
    ShapeArea As String,
    Modifier As iPerson,
    Optional Name As String = Nothing,
    Optional Rank As Integer = 0
) As ShapeCreateResult [V2]

Legt ein Shape innerhalb des globalen Website-Bereichs an.
Das Anlegen liefert im Status des Rückgabe-Objekts Failed, wenn das Shape an der gewünschten Stelle nicht erlaubt ist.
Ist ein benötigter Parameter nicht gültig, wird "InvalidValue" geliefert.

  • EditPage: Die Seite, in der dia Aktion ausgeführt wird
  • Type: Der Typ des neuen Shapes
  • ShapeArea: Die Shape-Area des neuen Shapes
    ACHTUNG: Shape-Areas können vom System nicht validiert werden - es ist sicherzustellen, dass der Name zum Template passt, ansonsten wird das Shape nicht angezeigt - an einer Lösung wird gearbeitet.
  • Modifier: Objekt der Person, die den Eintrag erstellt
  • Optionale Parameter
    • Name: Name des Shapes (zur Bildeung der Anker-URL), Ist kein Name angegeben wird der Name des Shapetypen mit einer fortlaufenden Zahl verwendet.
    • Rank: Rang des neuen Shapes. Ist er nicht gültig (also negativ oder größer als die Anzahl bestehender Unterelemente + 1), wird an letzter Stelle eingefügt
Copy

API.Shapes.CreateWebsiteShape(Model.Page, MyType, "Content", CurrentUser, Name:="Mein Shape", Rank:=42)

War dieser Beitrag hilfreich?
0 von 0 fanden dies hilfreich.
Schade! Bitte teilen Sie uns doch mit was Ihnen nicht weitergeholfen hat.
Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.