Hilfe-Center
  1. Startseite
  2. Technische Referenz
  3. API
  4. API-Objekte
  5. iShape

iShape

Repräsentiert ein Shape.

ReadOnly Property ID As Integer

Liefert die ID des Shapes

Copy

Model.Shape.ID

 ReadOnly Property ParentPage As iPage [V2]

Liefert die ID des Elternelements des Shapes

Copy

Model.Shape.ParentID

ReadOnly Property Name As String

Liefert den Namen des Shapes

Copy

Model.Shape.Name

ReadOnly Property Scope As Content.Enum.Scope

Liefert den Anzeigebereich des Shapes (All/Website/Page/Shape)

Copy

Model.Shape.Scope

ReadOnly Property Rank As Integer

Liefert die Position des Shapes

Copy

Model.Shape.Rank

ReadOnly Property Language As iLanguage [V2]

Liefert die Sprache des Shapes

Copy

Model.Shape.Language

ReadOnly Property ShapeArea As String

Liefert die Area des Shapes

Copy

Model.Shape.ShapeArea

ReadOnly Property Active As Boolean

Liefert true wenn das Shape aktiv ist, false wenn nicht

Copy

Model.Shape.Active

ReadOnly Property ShapeType As iShapeType

Liefert den Typen des Shapes als Objekt vom Typ iShapeType

Copy

Model.Shape.ShapeType

ReadOnly Property Version As Integer

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

Copy

Model.Shape.Version

ReadOnly Property CreatedOn As Date [V2]

Liefert den Zeitpunkt an welchen das Shape angefügt wurde

Copy

Model.Shape.CreatedOn

ReadOnly Property Creator As iPerson [V2]

Liefert den Administrator der das Shape angefügt hat

Copy

Model.Shape.Creator

ReadOnly Property ModifiedOn As Date [V2]

Liefert das Datum wann das Shape das letzte mal geändert wurde.

ReadOnly Property Modifier As iPerson [V2]

Liefert den Administrator der das Shape als letztes geändert hat.

ReadOnly Property ParentShape As iShape

Liefert das Elternshape als Objekt vom Typ iShape. Sofern kein Elternshape vorhanden ist (es also das höchste Shape einer Page ist, sprich Parent ist Page), wird Nothing geliefert.

Copy

Model.Shape.ParentShape

ReadOnly Property IsFirstLevel As Boolean

Gibt an, ob das SHape in der obersten Ebene liegt. Dies ist der Fall, wenn das Shape vom Scope Website oder Page ist.

Copy

Model.Shape.IsFirstLevel

Property MoveLevelsInDomUp As String

Gibt an wie viele Stellen im DOM die Bearbeitungselemente des Shapes nach oben geschoben werden sollen

Copy

Model.Shape.MoveLevelsInDomUp

ReadOnly Property URL(Optional EditMode As Boolean = False) As String

Gibt Die URL des Shapes zurück

Copy

Model.Shape.URL(true)

ReadOnly Property RootObjectPage As iPage

Liefert die Seite in der sich das Shape befindet

Copy

Model.Shape.RootObjectPage

Function SubShapes(
EditMode As Boolean,
Optional ShapeArea As String = ""
) As IEnumerable(Of iShape)

Liefert alle Shapes in diesem Shape

  • EditMode: Editmode
  • Optionale Parameter:
    • ShapeArea: Liefert, wenn angegeben nur die Shapes aus dieser Area
Copy

Model.Shape.SubShapes(True)

Function SubShapes(
ShapeTypeName As String,
EditMode As Boolean,
Optional ShapeArea As String = ""
) As IEnumerable(Of iShape) [V2]

Liefert alle Shapes in diesem Shape

  • EditMode: Editmode
  • ShapeTypeName: Name des ShapeTypes nach dem gefiltert werden soll
  • Optionale Parameter:
    • ShapeArea: Liefert, wenn angegeben nur die Shapes aus dieser Area

Function SubShapes(
ShapeTypeNames As IEnumerable(Of String),
EditMode As Boolean,
Optional ShapeArea As String = ""
) As IEnumerable(Of iShape) [V2]

Liefert alle Shapes in diesem Shape

  • EditMode: Editmode
  • ShapeTypeNames: Liste von ShapeType-Namen nach denen gefiltert werden sollen
  • Optionale Parameter:
  • ShapeArea: Liefert, wenn angegeben nur die Shapes aus dieser Area

Function SubShapesRecursive(
EditMode As Boolean,
Optional ShapeArea As String = ""
) As IEnumerable(Of iShape)

Liefert alle Shapes in diesem Shape und dessen Untershapes

  • EditMode: Editmode
  • Optionale Parameter:
    • ShapeArea: Liefert, wenn angegeben nur die Shapes aus dieser Area

Function SubShapesRecursive(
ShapeTypeName As String,
EditMode As Boolean,
Optional ShapeArea As String = ""
) As IEnumerable(Of iShape) [V2]

Liefert alle Shapes in diesem Shape und dessen Untershapes gefiltert nach dem ShapeType

  • EditMode: Editmode
  • ShapeTypeName: Name des ShapeTypes nach dem gefiltert werden soll
  • Optionale Parameter:
    • ShapeArea: Liefert, wenn angegeben nur die Shapes aus dieser Area

Function SubShapesRecursive(
ShapeTypeNames As IEnumerable(Of String),
EditMode As Boolean,
Optional ShapeArea As String = ""
) As IEnumerable(Of iShape) [V2]

Liefert alle Shapes in diesem Shape und dessen Untershapes gefiltert nach einer Liste von ShapeTypes

  • EditMode: Editmode
  • ShapeTypeNames: Liste von ShapeType-Namen nach denen gefiltert werden sollen
  • Optionale Parameter:
  • ShapeArea: Liefert, wenn angegeben nur die Shapes aus dieser Area

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

Liefert ein Attribut des Shapes

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

Model.Shape.GetAttributeValue("Text1", True)

 Function GetAttributeValues(Name As String, EditMode As Boolean) As IEnumerable(Of iAttributeValue)

Liefert alle Werte des Attributes des Shapes

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Shape.GetAttributeValues("Text1", True)

Function GetDateAttributeValues(Name As String, EditMode As Boolean) As IEnumerable(Of iTypedDate)

Liefert den Attribute Datumwert des Shapes 

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Shape.GetDateAttributeValues("Date1", True)

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

Liefert ein Datumsattribut des Shapes

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

Model.Shape.GetDateAttributeValue("Date1", True)

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

Liefert ein Dateiattribut des Shapes

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

Model.Shape.GetFileAttributeValue("File1", True)

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

Liefert ein Bildattribut des Shapes

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

Model.Shape.GetImageAttributeValue("Image1", True)

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

Liefert ein Linkattribut des Shapes

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

Model.Shape.GetLinkAttributeValue("Link1", True)

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

Liefert ein Textattribut des Shapes

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

Model.Shape.GetTextAttributeValue("Text1", True)

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

Liefert ein Integer-Attribut des Shapes

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

Model.Shape.GetIntegerAttributeValue("Integer1", True)

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

Liefert ein Decimal-Attribut des Shapes

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

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

Liefert ein Boolean-Attribut des Shapes

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

Model.Shape.GetBooleanAttributeValue("Boolean1", True)

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

Liefert ein Dropdown-Attribut des Shapes

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

Model.Shape.GetDropdownAttributeValue("Dropdown1", True)

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

Liefert den Attribute Dropdown des Shapes

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

Model.Shape.GetDropdownAttributeValues("Dropdown1", True)

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

Liefert ein Dateiattribut des Shapes 

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Shape.GetFileAttributeValues("File1", True)

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

Liefert ein Bildattribut des Shapes 

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Shape.GetImageAttributeValues("Image1", True)

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

Liefert ein Linkattribut des Shapes 

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Shape.GetLinkAttributeValues("Link1", True)

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

Liefert ein Textattribut des Shapes 

  • Name: Name des Attributes
  • EditMode: Editmode
Copy

Model.Shape.GetTextAttributeValues("Text1", True)

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

Speichert ein Datumsattribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape nicht existiert.

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

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

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

Speichert ein Boolean-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape nicht existiert.

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

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

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

Speichert ein Dropdown-Attribut des Shapes.
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 im Shape nicht existiert.

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

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

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

Setzt mehrere Dropdown-Attribute des Shapes
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 im Shape nicht existiert.

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

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

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

Speichert ein Text-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape nicht existiert.

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

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

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

Speichert ein Integer-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape 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.Shape.SetIntegerAttributeValue("MyAttr", 5, CurrentUser)

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

Speichert ein Decimal-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape 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.Shape.SetDecimalAttributeValue("MyAttr", 2.6, CurrentUser)

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

Speichert ein File-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape nicht existiert. Gibt es keine Datei zur gegebenen ID wird "Invalid Value" geliefert.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert (ID der Datei)
  • Modifier: Die ausführende Person
Copy

Model.Shape.SetFileAttributeValue("MyAttr", MyFile.ID, CurrentUser)

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

Speichert mehrere Werte in ein File-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape 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
  • NewValue: Der zu speichernde Wert (Liste von IDs der Dateien)
  • Modifier: Die ausführende Person
Copy

Model.Shape.SetFileAttributeValues("MyAttr", New List(Of Integer) From {1,3,6,9}, CurrentUser)

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

Setzt ein File-Attribut des Shapes für Multiple-Attribut

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

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

Speichert ein Image-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape nicht existiert. Gibt es keine Datei zur gegebenen ID wird "Invalid Value" geliefert.

  • Name: Name des Attributs
  • NewValue: Der zu speichernde Wert (ID der Datei)
  • Modifier: Die ausführende Person
Copy

Model.Shape.SetImageAttributeValue("MyAttr", MyFile.ID, CurrentUser)

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

Speichert mehrere Werte in ein Image-Attribut des Shapes.
Es wird "Failed" geliefert, wenn der angegebene Attributname im Shape 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
  • NewValue: Der zu speichernde Wert (Liste von IDs der Dateien)
  • Modifier: Die ausführende Person
Copy

Model.Shape.SetImageAttributeValues("MyAttr", New List(Of Integer) From {1,3,6,9}, CurrentUser)

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

Setzt ein Image-Attribut des Shapes für Multiple-Attribut

  • Name: Name des Attributs
  • NewImage: Bild welches in das Attribut gespeichert werden soll
  • Modifier: Person welche das Attribut speichert

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 des Shapes.

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.Shape.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 des Shapes.

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.Shape.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 des Shapes.

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.Shape.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 internen Link mit einem Shape als Ziel in ein Link-Attribut des Shapes.

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.Shape.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 des Shapes.

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.Shape.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 des Shapes.

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.Shape.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 des Shapes.

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.Shape.SetLinkAttributeValue("myAttr", "test@test.test", "Hierhin führt der Link", "Hier klicken", False, 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 des Shapes.

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.Shape.SetMultipleLinkAttributeValue("myAttr", "test@test.test", "Hierhin führt der Link", "Hier klicken", False, 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 des Shapes. 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.Shape.SetLinkAttributeValue("myAttr", "https://www.procomp.de", "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

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

Speichert einen zusätzlichen externen Link in ein Multiple-Link-Attribut des Shapes. 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.Shape.SetMultipleLinkAttributeValue("myAttr", "https://www.procomp.de", "Hierhin führt der Link", "Hier klicken", False, CurrentUser)

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

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

Function IsOfType(
ShapeTypeNames As IEnumerable(Of String),
Optional RaiseException As Boolean = False
) As Boolean

Prüft, ob einer der übergebenen Namen dem des Shapetypen entspricht.

Folgende drei Schreibweisen bewirken das Selbe:

Copy

MyShape.IsOfType("apfel") OrElse MyShape.IsOfType("banane"})

MyShape.IsOfType(New List(Of String)({"apfel", "banane"}))

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

Function Delete(Modifier As iPerson) As API.Enum.ShapeDeleteResult [V2]

Löscht das Shape. 
WICHTIG: Diese Funktion kann nicht auf Website-Shapes ausgeführt werden.

  • Modifier: die ausführende Person.
Copy

MyShape.Delete(CurrentUser)

Function DeleteWebsiteShape(EditPage As iPage, Modifier As iPerson) As API.Enum.ShapeDeleteResult [V2]

Löscht das Shape. 
WICHTIG: Diese Funktion kann nur auf Website-Shapes ausgeführt werden.

  • EditPage: die Seite, auf der die Aktion stattfindet
  • Modifier: die ausführende Person.
Copy

MyWebsiteShape.DeleteWebsiteShape(Model.Page, CurrentUser)

War dieser Beitrag hilfreich?
11 von 13 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.