Dokumentation der XSLT Erweiterungen in cardo
Hinweis: Die Extension werden von cardo in den Modulen cardo.Puzzle und cardo.Button im Namespace eo:iduCore registriert.
Die mit "iduPdf" gekennzeichneten Erweiterungsfunktionen gehören zum Erweiterungsobjekt eo:iduPdf und sind nur für den PDF- Ausgabemodus vorgesehen.
Die mit "iduDocX" gekennzeichneten Erweiterungsfunktionen gehören zum Erweiterungsobjekt eo:iduDocX und sind nur für den DocX - Ausgabemodus vorgesehen.
<xsl:stylesheet version="1"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:iduCore="eo:iduCore" xmlns:iduPdf="eo:iduPdf" xmlns:iduDocX="eo:iduDocX">
<!-- your Code here -->
</xsl:stylesheet>
AddToArgsList,
AddLayerToLayerList,
CleanupTempFilesInDispose,
ConvertInfoTypeBBoxToIxrhBBox,
ConvertWktToEWkt,
CreateLegendImageByLayerName,
CreateMapImage,
DecodeLocalName,
DistinctValues,
FormatByteSize,
FormatDateTime,
FormatNumber,
FormatPlainTextToHtml,
GetArgumentValue,
GetAvailableXsltArguments,
GetCounter,
GetGeomArea,
GetGeomDistance,
GetGeomLength,
GetGeomPerimeter,
GetIxrhValidatedReader,
GetMarkerSketchGraphicsFromGeom,
GetMarkerSketchGraphicsFromMapReader,
GetSketchGraphicsFromGeom,
GetTicksFromDateTime,
IncreaseCounter,
InitCounter,
InitCounter,
InnerXml,
IsRenderTargetDOCX,
IsRenderTargetPDF,
LastCreateMapResponse,
LogMessages,
MapCalculateBboxToBestScale,
MapCreateSelLayer,
MapModifyBBox,
MapModifyBBox,
MapModifyBBoxToBestScale,
MapModifyBBoxToScale,
MapModifyBBoxZoomToGeom,
MapModifyBBoxZoomToGeomWithOffset,
MapModifyLayerList,
MapModifySetSketch,
MapQueryReturnXmlDocument,
ModifyMapQueryFilterValues,
Now,
ParseXml,
ReformatXmlString,
Replace,
ResolveImageUrlAsDataUrl,
ResolveImageUrlToLocalFile,
SelectNodesByXPathString,
SelectSingleNodeByXPathString,
SetCounter,
SetForcePdfCompatibleURIs,
StringJoin,
StringSplit,
ToLower,
ToUpper,
TransformGeom,
AppendPdfDocumentFromCardoPuzzleDocument,
AppendPdfDocumentFromFile,
AppendPdfDocumentFromIkxStoredBlob,
CreatePdfAttachmentFromBytes,
CreatePdfAttachmentFromFile,
CreatePdfAttachmentFromIkxStoredBlob,
SetMargin,
SetMargins,
SetOrientation,
SetPageSize,
SetPageSizeByName,
SetPdfDocumentProperties,
SetPdfDocumentSecurity,
SetPdfHeaderAndFooter,
AppendDocumentFromIkxStoredBlob,
AppendPdfDocumentFromCardoPuzzleDocument,
CreateAttachmentFromFile,
SetDocXHeaderAndFooter,
SetMargin,
SetMargins,
SetOrientation,
SetPageSize,
SetPageSizeByName,
AddLayerByTagsToLayerList,
CreateLegendImageByLayerTag,
GetCurrentApplicationRootUrl,
GetFileIconByName,
GetLayerListFromMyMap,
GetLayerTag,
GetLayerTitle,
GetPuzzleDataByQPzlId,
GetPuzzleDataForNode,
GetVisibleLayerListFromView,
IkxCheckEntityExists,
IkxGetClassDescription,
IkxGetClassLabel,
IkxGetClassXml,
IkxGetEntityDescription,
IkxGetEntityGroupName,
IkxGetEntityLabel,
IkxGetEntitySortHint,
IkxGetEntityTabName,
IkxHasAtLeastOneEntityInGroupEffectiveRight,
IkxHasEffectiveRight,
IkxIsEntityMeaningSet,
IkxIsStoreSelected,
IkxRenderMimeTypeValueToHtml,
IkxSelectIkxStore,
IsAnonymous,
IsUserIsInRole,
UserDescription,
UserName,
XPathToNode
AddToArgsList(XsltArgumentList argList, TargetMode targetMode, String xsltBaseFolder, StringMessages messages)
Verfügbar in: eo:iduCore
cardo-ExtensionObject einer ArgumentList hinzufügen
(als static, da der Konstruktor nicht public aber so auch in externen aspx registriert werden kann)
Argumente
- argList
- targetMode
- xsltBaseFolder
- messages
AddLayerToLayerList(XPathNodeIterator oldLayerList, String layerNames)
Verfügbar in: eo:iduCore
Fügt Layer an eine bestehende LayerList an
Argumente
- oldLayerList
die bisherige Layerliste
- layerNames
ein oder mehrere Layer-Namen (LXXX), die einzelnen Layer sind durch ein | zu trennen
CleanupTempFilesInDispose(Boolean mode)
Verfügbar in: eo:iduCore
Aktiviert oder deaktiviert das Löschen temp. erstellter Dokumente nach dem Beenden der Aktion.
Standardmäßig ist diese Funktion aktiviert.
Argumente
ConvertInfoTypeBBoxToIxrhBBox(XPathNodeIterator infoTypeBbox)
Verfügbar in: eo:iduCore
Konvertiert einen Extent aus dem Namespace http://schemas.webs.idu.de/iwan/informationTypes in einen Extent im Namespace http://schemas.webs.idu.de/iwan/iXRH.
Z.B. für die Weiterverwendung des BoundingBox Typen aus dem Ergebnis der Methode MapCreateSelLayer
Argumente
ConvertWktToEWkt(String wkt, Int32 epsg)
Verfügbar in: eo:iduCore
Konvertiert anhand der übergebenen EPSG eine Geometrie im WKT-Format in eine EWKT-Geometrie
(es handelt sich hier nicht um eine Transformation sondern lediglich um eine Zuweisung der richtigen EPSG)
Argumente
- wkt
String WKT-Geometrie
- epsg
Zugehörige EPSG in der die WKT-Geometrie vorliegt
Rückgabe
String EWKT-Geometrie
CreateLegendImageByLayerName(String layerName)
Verfügbar in: eo:iduCore
Gibt die URL zum Legendenbild für eine Ebene, die zu übergeben ist, aus
Argumente
- layerName
ein Layer-Name (LXXXX) - die Legende wird für diese Ebene erzeugt
CreateMapImage(XPathNodeIterator node)
Verfügbar in: eo:iduCore
Erzeugt ein Kartenbild und gibt die Url zu dem erstellten Bild zurück.
Weitere Details zum Kartenbild können mittels LastCreateMapResponse abgerufen werden.
Der Parametersatz kann mit verschiedenen Methoden transformiert werden.
In der Praxis wird das Element "Option" in einem Button-Plan eingesetzt und mit den
ModifyMap** Methoden geändert.
Beispiel
<img >
<xsl:attribute name="src">
<xsl:value-of select="cardoButton:CreateMapImage(
cardoButton:MapModifySetSketch(
cardoButton:MapModifyLayerList($imageProps,'L17'),
cardoButton:GetMarkerSketchGraphicsFromMapReader($filterProps,
'L17',
'red',
'FilledCircle',10,
'OBJECTID',12,
'LowerLeft',
'Black','Silver')
),-1
)"/>
</xsl:attribute>
</img>
Achtung: Iwan arbeitet mit 80 dpi (bzw. 3200 PixelPerMeter)
imageWidth und imageHeight werden als solche Iwan-Pixel interpretiert
ein typisches Dokument hat aber eine Auflösung von 96 dpi (bzw. 3840 PixelPerMeter,
das von Iwan generierte Bild wird also nur maßstäblich dargestellt, wenn es
bei der Ausgabe auf 96 dpi skaliert wird
Argumente
- node
der Parametersatz für das zu erstellende Karten-Bild, muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
DecodeLocalName(String localName)
Verfügbar in: eo:iduCore
Decodiert einen Elementnamen, der von einer Methode erstellt wurde, die diesen zuvor mit Decode umgewandelt hat. Z.B. als Ergebnis der Methode MapQueryReturnXmlDocument
Argumente
DistinctValues(XPathNodeIterator values)
Verfügbar in: eo:iduCore
Erstellt aus den String-Werten der Liste Value eine neue Liste der eindeutigen Werte.
Argumente
FormatByteSize(Int64 byteLength)
Verfügbar in: eo:iduCore
Gibt eine Zahl formatiert als Byte/MByte etc. zurück
Argumente
FormatDateTime(DateTime value, String formatString, Boolean useInvariantCultur)
Verfügbar in: eo:iduCore
Formatiert eine Datum in eine Zeichenkette, verwendet intern value.Format (wobei value = DateTime).
Argumente
- value
Der zu formatierende DateTime Wert
- formatString
Ein .Net Format-String
- useInvariantCultur
InvariantCulture.NumberFormat verwenden
FormatNumber(Double value, String formatString, Boolean useInvariantCultur)
Verfügbar in: eo:iduCore
Formatiert eine Zahl in eine Zeichenkette, verwendet Double.ToString
Argumente
- value
Der zu formatierende Zahlenwert (Double)
- formatString
Ein .Net Format-String, siehe Double.ToString
- useInvariantCultur
InvariantCulture.NumberFormat verwenden
FormatPlainTextToHtml(String value, Boolean escapeLines, String paragraphElement, String emptyEl)
Verfügbar in: eo:iduCore
Konvertiert einen Plain-Text in X(html), wobei Umbrüche als Absätze dargestellt werden.
Zurück kommt ein Text, der ohne output-escaping eingefügt werden kann.
Argumente
- value
Der zu formatierende Wert
- escapeLines
Die Werte pro Zeile Xml Encoden
- paragraphElement
Das Absatz-HTML Element (z.B. 'p') oder 'br' (wird gesondert behandelt, Zeilen werden dann mit br umbrochen, kein umschließendes Element)
- emptyEl
Der Text der zurückgegeben werden soll, wenn value leer ist
GetArgumentValue(String name, Boolean lookupInRequest)
Verfügbar in: eo:iduCore
Gibt einen Wert aus dem durch die Umgebung übergebenen Argumentenspeicher zurück.
Wurde lookupInRequest -1 (true) übergeben, dann wird als Fallback im Http-Request nachgeschaut.
Argumente
- name
der Parametername, case-insensitiv
- lookupInRequest
Wert aus dem QueryString Argumenten auslesen (nachrangig gegenüber Programm-Argumenten)
GetAvailableXsltArguments()
Verfügbar in: eo:iduCore
Ermitteln der Namen aller verfügbaren Erweiterungsobjekt-Argumente.
Rückgabe
String: als XML serialisiertes Array von Argumentnamen
GetCounter(String key)
Verfügbar in: eo:iduCore
Gibt den aktuellen Wert des Zählers zurück.
Argumente
- key
Id des Zählers (Zähler muss bereits unter diesem Schlüssel registriert sein)
Rückgabe
Aktueller Wert des Zählers
GetGeomArea(String geomInAnyFormat)
Verfügbar in: eo:iduCore
Gibt den Umfang eines Polygons zurück
Argumente
- geomInAnyFormat
Die Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.) - muss ein Polygon sein!
Rückgabe
der Flächeninhalt der Fläche in Quadradtmetern - wenn es keine Fläche ist, wird 0 zurückgegeben
GetGeomDistance(String geomInAnyFormatA, String geomInAnyFormatB)
Verfügbar in: eo:iduCore
Bestimmt den Abstand zwischen zwei Geometrien
Argumente
- geomInAnyFormatA
Die erste Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.)
- geomInAnyFormatB
Die zweite Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.)
Rückgabe
der Abstand beider Geometrien
GetGeomLength(String geomInAnyFormat)
Verfügbar in: eo:iduCore
Gibt die Länge einer Linie zurück
Argumente
- geomInAnyFormat
Die Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.) - muss eine Linie sein!
Rückgabe
die Länge der Linie in Metern - wenn es keine Linie ist, wird 0 zurückgegeben
GetGeomPerimeter(String geomInAnyFormat)
Verfügbar in: eo:iduCore
Gibt den Umfang eines Polygons zurück
Argumente
- geomInAnyFormat
Die Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.) - muss ein Polygon sein!
Rückgabe
der Umfang der Fläche in Metern - wenn es keine Fläche ist, wird 0 zurückgegeben
GetIxrhValidatedReader(XPathNodeIterator node)
Verfügbar in: eo:iduCore
der Node, aus dem der Reader erstellt werden soll
der Node muss dazu schon an die richtige Stelle gemoved sein
Argumente
GetMarkerSketchGraphicsFromGeom(String geomInAnyFormat, String markerColor, String markerSymbolEnum, Int32 markerSize, String labelText, Int32 fontSize, String fontAnchor, String fontColor, String fontBackgroundColor)
Verfügbar in: eo:iduCore
Erstellt Sketch-Elemente für jeden Centroid der Geom und gibt das sich ergebende JSON Dokument für die Übergabe
an einen Parametersatz für eine Kartenanforderung zurück. Wird in Verbindung mit
MapModifySetSketch genutzt.
Die Elemente werden via CenterPoints beschafft
Argumente
- geomInAnyFormat
Die Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.)
- markerColor
Farbwert für den Marker
- markerSymbolEnum
Ein Wert des Enums IDU.Sketch.Primitives.MarkerSymbol (FilledCircle, FilledRect, OutlinedCircle, OutlinedStar, ...)
- markerSize
die Größe des Markers in Pixeln
- labelText
optionaler Text für die Beschriftung der Marker
- fontSize
Schriftgröße in Pixeln
- fontAnchor
ein Wert des Enums IDU.Sketch.Primitives.TextAnchor (CenterCenter, CenterLeft, UpperRight)
- fontColor
Schriftfarbe
- fontBackgroundColor
Hintergrundfarbe (optional)
GetMarkerSketchGraphicsFromMapReader(XPathNodeIterator mapQueryElement, String layerName, String markerColor, String markerSymbolEnum, Int32 markerSize, String labelColumnName, Int32 fontSize, String fontAnchor, String fontColor, String fontBackgroundColor)
Verfügbar in: eo:iduCore
Liest die Datensätze der Ebene mit dem übergebenen Filter aus.
Erstellt Sketch-Elemente für jeden Datensatz und gibt das sich ergebende JSON Dokument für die Übergabe
an einen Parametersatz für eine Kartenanforderung zurück. Wird in Verbindung mit
MapModifySetSketch genutzt.
Die Geometrie wird via CenterPoints der betroffenen Datensätze beschaft.
Argumente
- mapQueryElement
Ein Filter-Element (<Query xmlns='http://schemas.webs.idu.de/iwan/iXRH'>)
- layerName
der Name der Iwan - Ebene (L0815)
- markerColor
Farbwert für den Marker
- markerSymbolEnum
Ein Wert des Enums IDU.Sketch.Primitives.MarkerSymbol (FilledCircle, FilledRect, OutlinedCircle, OutlinedStar, ...)
- markerSize
die Größe des Markers in Pixeln
- labelColumnName
optionaler Spaltenname für die Beschriftung der Marker
- fontSize
Schriftgröße in Pixeln
- fontAnchor
ein Wert des Enums IDU.Sketch.Primitives.TextAnchor (CenterCenter, CenterLeft, UpperRight)
- fontColor
Schriftfarbe
- fontBackgroundColor
Hintergrundfarbe (optional)
GetSketchGraphicsFromGeom(String geomInAnyFormat, String borderColor, Int32 borderWidth, String fillColor, Int32 fillAlpha)
Verfügbar in: eo:iduCore
Erstellt ein Sketch-Element aus der übergebenen Geometrie und gibt das sich ergebende JSON Dokument für die Übergabe
an einen Parametersatz für eine Kartenanforderung zurück. Wird in Verbindung mit
MapModifySetSketch genutzt.
Als Geometrien sind nur Flächen und Linien zulässig. Multiparts werden berücksichtigt.
Argumente
- geomInAnyFormat
Die Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.)
- borderColor
optional: Farbe der Linie. Bei Liniengeometrien wird schwarz als Standardfarbe verwendet. Bei Flächen wird die Umrandung weggelassen, wenn keine Farbe übergeben wird. Die Linie wird immer durchgezogen gemalt.
- borderWidth
Breite der Linie in Pixeln
- fillColor
optional: Füllfarbe. Wird diese bei Flächen nicht angegeben, wird keine Füllung gemalt. Die Angabe wird bei Liniengeometrien ignoriert.
- fillAlpha
Alphawert für die Füllung der Fläche (0 => keine Transparenz; 100 => voll transparent)
GetTicksFromDateTime(DateTime time)
Verfügbar in: eo:iduCore
Gibt die Ticks des übergebenen DateTime Objekts zurück.
Argumente
IncreaseCounter(String key)
Verfügbar in: eo:iduCore
erhöht den Zähler um 1.
Argumente
- key
Id des Zählers (Zähler muss bereits unter diesem Schlüssel registriert sein)
Rückgabe
Aktuellen Wert des Zählers nach der Operation
InitCounter(String key)
Verfügbar in: eo:iduCore
Legt einen neuen Zähler mit dem übergebenen Schlüssel an.
Der Zähler wird mit 0 initialisiert.
Argumente
- key
Schlüssel, über welchen der Zähler registriert wird
InitCounter(String key, Int32 value)
Verfügbar in: eo:iduCore
Legt einen neuen Zähler mit dem übergebenen Schlüssel an
und initialisiert ihn mit dem übergebenen Wert.
Argumente
InnerXml(XPathNodeIterator node)
Verfügbar in: eo:iduCore
Gibt das Inner-Xml des Nodeset als Zeichenkette zurück
Argumente
Rückgabe
String: als String serialisertes XML
IsRenderTargetDOCX()
Verfügbar in: eo:iduCore
Gibt true zurück, wenn die aktuelle Erstellung primär für DOCX gedacht ist.
IsRenderTargetPDF()
Verfügbar in: eo:iduCore
Gibt true zurück, wenn die aktuelle Erstellung primär für PDF gedacht ist.
LastCreateMapResponse()
Verfügbar in: eo:iduCore
Gibt Informationen zu dem letzten mittels CreateMapImage erstellten Kartenbild zurück, z.B. Maßstab, Bildgröße etc.
Ausgabe
Beispiel
<iXRH:ImageResponse imageWidth="500"
imageHeight="500"
imageSizeLargestEdge="500"
mapScale="2570.33"
contextType="MapImage"
targetImageType="Png24"
durationFromRequestToCompress="77"
creationDurationMilliSeconds="105"
imageState="Complete"
xmlns:iXRH="http://schemas.webs.idu.de/iwan/iXRH">
<iXRH:BBox
epsgCode="31469"
xmin="5334296.16162"
ymin="5705771.04547"
xmax="5334697.77593"
ymax="5706172.65978" />
</iXRH:ImageResponse>
Zugriff
Beispiel
<xsl:value-of select="iduCore:LastCreateMapResponse()/iXRH:ImageResponse/@mapScale"/>
LogMessages(Boolean mode)
Verfügbar in: eo:iduCore
Legt fest ob detailliertes Logging aktiviert/deaktiviert werden soll. Per Default ist das Logging deaktiviert.
Zurückgegeben wird der effektive Wert (es kann sein, dass die Umgebung keinen Logger breitstellt)
Argumente
MapCalculateBboxToBestScale(Double farToNearBalance, XPathNodeIterator extentNode, Int32 mapWidth, Int32 mapHeight, XPathNodeIterator scalesNode)
Verfügbar in: eo:iduCore
Passt einen Extent so an, dass er in einem der übergebenen Maßstäbe liegt. Passt der Extent in keinen Kartenausschnitt mit einem der gegebenen Maßstäbe hinein, wird der Eingangswert verwendet.
Beispiel
<xsl:variable name="AdjustedBbox"
select="ce:MapCalculateBboxToBestScale(
0.75,
ce:ConvertInfoTypeBBoxToIxrhBBox($selLayerNameAndguid/infoTypes:BoundingBox),
600,600,
'1000,1500,2000,2500')" />
Argumente
- farToNearBalance
bei farToNearBalance=1 ist sichergestellt, dass der hereingegebene Extent garantiert im Kartenbild zu sehen ist. Bei Absenkung des Wertes, wird dann mehr und mehr ein Beschneiden zugelassen und der mehr hereingezoomte Level verwendet. Der Wert 0 bedeutet, dass immer der nächstniedrige Maßstab - sofern es noch einen gibt - verwendet wird.
- extentNode
Ein BoundingBox_Type aus dem Namespace http://schemas.webs.idu.de/iwan/iXRH
- mapWidth
Kartenbreite in Pixeln
- mapHeight
Kartenhöhe in Pixeln
- scalesNode
Liste von Nodes, welche die möglichen Maßstabszahlen enthalten (einzeln, kommagetrennt oder auch notiert als kommagetrennter Text (String)
MapCreateSelLayer(XPathNodeIterator node, String layerName)
Verfügbar in: eo:iduCore
Erstellt eine Selektionsebene und gibt einen SelRenderLayer_Type (Element IxrhSelLayerInfo) zurück.
Beispiel
<ns:IxrhSelLayerInfo maxAgeSeconds="86400" sourceLayerName="L141" isSessionDepended="true" xmlns:ns="http://schemas.webs.idu.de/iwan/informationTypes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ns:RecordCount>1</ns:RecordCount>
<ns:Guid>e8acc523-3ea0-4528-b099-2002de47eaae</ns:Guid>
<ns:BoundingBox epsg="31469">
<ns:Min x="5334396.16162424" y="5705884.58376304" />
<ns:Max x="5334597.77593064" y="5706059.12148559" />
</ns:BoundingBox>
</ns:IxrhSelLayerInfo>
Argumente
- node
Query-Element(<Query xmlns='http://schemas.webs.idu.de/iwan/iXRH'>)
- layerName
der interne Ebenen-Name (L12)
MapModifyBBox(XPathNodeIterator node, Double epsgCode, Double xmax, Double xmin, Double ymax, Int32 ymin)
Verfügbar in: eo:iduCore
Ändert den Extent für den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
CreateMapImage
Argumente
- node
der Parametersatz für das zu erstellende Karten-Bild, muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- epsgCode
- xmax
- xmin
- ymax
- ymin
MapModifyBBox(XPathNodeIterator node, XPathNodeIterator bboxNode)
Verfügbar in: eo:iduCore
Ändert den Extent für den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
CreateMapImage
Argumente
- node
der Parametersatz für das zu erstellende Karten-Bild, muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- bboxNode
ein Knoten, der in einen BoundingBox_Type konvertiert werden kann.
MapModifyBBoxToBestScale(XPathNodeIterator node, Double farToNearBalance, XPathNodeIterator scalesNode)
Verfügbar in: eo:iduCore
Ändert den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
Passt den Kartenausschnitt so an, dass sich, bei der für das Kartenbild eingestellten Pixelgröße des Kartenbildes,
einer der übergebenen Maßstäbe ergibt. Passt der Extent in keinem der Maßstäbe in das Bild, bleibt der Ausschnitt unverändert.
CreateMapImage
Argumente
- node
Der Parametersatz für das zu erstellende Karten-Bild - muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- farToNearBalance
Angabe zwischen 0 und 1, mit der vorgegeben wird, ob bei der Wahl des besten Maßstabes eher zur
größeren Maßstabszahl tendiert werden soll, d.h. vom bisherigen Kartenausschnitt wird kein Teil abgeschnitten (1) oder ob es zulässig ist,
mit gewissen "Verlusten" auch die kleinere Maßstabszahl zu wählen (Werte von 1 abwärts).
Der Wert 0 bedeutet, dass immer der nächstniedrige Maßstab - sofern es noch einen gibt - verwendet wird.
- scalesNode
Liste von Nodes, welche die Maßstäbe enthalten (einzeln, kommagetrennt oder auch notiert als kommagetrennter Text (String)
MapModifyBBoxToScale(XPathNodeIterator node, Double scale)
Verfügbar in: eo:iduCore
Ändert den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
Passt den Kartenausschnitt so an, dass sich, bei der für das Kartenbild eingestellten Pixelgröße des Kartenbildes,
der übergebene Maßstab ergibt. Der Extent wird um das aktuelle zentrum vergrößert bzw. verkleinert.
CreateMapImage
Argumente
- node
Der Parametersatz für das zu erstellende Karten-Bild - muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- scale
der Wunsch-Maßstab
MapModifyBBoxZoomToGeom(XPathNodeIterator node, String geomInAnyFormat, Double minSize)
Verfügbar in: eo:iduCore
Ändert den Extent für den Kartenausschnitt in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
Zoomt dabei auf die übergebene Geometrie und erstellt ein Kartenbild, das mindestens die übergebenen Größe (Karteneinheiten) besitzt.
CreateMapImage
Argumente
- node
der Parametersatz für das zu erstellende Karten-Bild, muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- geomInAnyFormat
Die Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.)
- minSize
Mindestgröße der BBox in Karteneinheiten
MapModifyBBoxZoomToGeomWithOffset(XPathNodeIterator node, String geomInAnyFormat, Double offset)
Verfügbar in: eo:iduCore
Ändert den Extent für den Kartenausschnitt in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
Zoomt dabei auf die übergebene Geometrie und erstellt ein Kartenbild, das um die Geometrie den übergebenen Offset als "Rand" belässt
Argumente
- node
der Parametersatz für das zu erstellende Karten-Bild, muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- geomInAnyFormat
Die Geometrie in einem der möglichen Formate (WKT, EWKT, Iwan etc.)
- offset
Mindestabstand der Geometrie zum Bildrand in Karteneinheiten
MapModifyLayerList(XPathNodeIterator node, XPathNodeIterator layerList)
Verfügbar in: eo:iduCore
Ändert die Ebenen-Liste in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
CreateMapImage
Argumente
- node
der Parametersatz für das zu erstellende Karten-Bild, muss dem Element "RenderMap" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- layerList
Die Ebenennamen als Node-Liste
MapModifySetSketch(XPathNodeIterator node, String sketchJson, Boolean append)
Verfügbar in: eo:iduCore
Ändert die Ausgestaltungselemente (Overlays, die via Sketch-Grafik dargestellt werden) in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück.
CreateMapImage
Argumente
- node
- sketchJson
Eine Zeichenfolge die das JSON zur Beschreibung der Grafiken liefert
- append
Gibt an, ob das Sketch angefügt werden soll oder die anderen ersetzt.
MapQueryReturnXmlDocument(XPathNodeIterator queryNode, String layerName)
Verfügbar in: eo:iduCore
Führt eine Abfrage auf eine Ebene durch und gibt als Antwort eine Xml Dokument mit allen Zeilen zurück.
Das Dokument hat folgenden Aufbau:
Spaltenbeschreibung:
Result\Cols\{UpperCaseSpaltenName}@ordinal,@typeName Value = orginalname, wie in der Quelle definiert.
Daten:
Result\Rows\(0..n) Row\{UpperCaseSpaltenName} = Value = Wert.
Hinweise:
Spalten mit NULL Werten werden übersprungen.
Geometrie-Werte werden in der Iwan internen Stringrepräsentation zurückgegeben.
Die Elementnamen der Spalten werden mit EncodeLocalName maskiert, verwende DecodeLocalName zur Generierung der Klarnamens
Argumente
- queryNode
Abfragedefinition (<Query xmlns='http://schemas.webs.idu.de/iwan/iXRH'>)
- layerName
Interner Name der Ebene
ModifyMapQueryFilterValues(XPathNodeIterator node, XPathNodeIterator values)
Verfügbar in: eo:iduCore
Modifiziert eine Abfrage für eine Geodatenebene und gibt ein Element QueryTypeWithOutputHint_Type zurück.
Argumente
- node
der Parametersatz für die Abfrage, muss dem Element "Query" im Namespace "http://schemas.webs.idu.de/iwan/iXRH" entsprechen.
- values
Die einzusetzenden Werte
Now()
Verfügbar in: eo:iduCore
Gibt das aktuelle Datum/Uhrzeit zurück
ParseXml(String xml)
Verfügbar in: eo:iduCore
Erstellt ein NodeSet aus dem als String übergebenem Xml
Argumente
- xml
gültiges XML als String
Rückgabe
XML-Knotenmenge
ReformatXmlString(String xml)
Verfügbar in: eo:iduCore
Parsed den String, formatiert das XML und gibt
dieses wieder als String aus. Damit dieses korrekt in
html ausgegeben wird, muss es von einem pre-Tag umschlossen sein.
Argumente
- xml
gültiges XML als String
Rückgabe
String: neu formatiertes XML als String
Replace(String, String, String)
Verfügbar in: eo:iduCore
Ersetzt in einer Zeichenkette alle Vorkommen eines Textfragments
durch den Ersetzungstext.
ResolveImageUrlAsDataUrl(String imageUri, Boolean onlyInWebMode)
Verfügbar in: eo:iduCore
Wie ResolveImageUrlAsDataUrl, konvertiert das Bild aber als DataUrl .
Argumente
- imageUri
- onlyInWebMode
Die DataUrl nur im web-Mode generieren, wenn anderer Mode und hier true, verhält sich die Funktion genau wie ResolveImageUrlToLocalFile
ResolveImageUrlToLocalFile(String imageUri)
Verfügbar in: eo:iduCore
Erstellt einen absoluten Pfad für den Download einer beliebigen Datei.
Je nach Umgebung können auch Variablen verwendet werden (%PATH_XY%).
Es können auch in DLLs eingebettete Resourcen abgerufen werden.
Dabei muss als 1. das Assembly, dann der Resource-Name angegeben weden. Bsp.: res://idu.core/IDU.Core/Web/Res/Resources/src/Res.js
Im Web-Modus gilt:
- Alle absoluten Web-Urls werden wie angegeben durchgereicht
- Auf alle Dateien (UNC oder lokal) wird via Service=UTIL&Request=DownloadFile zugegriffen
- Alle relativen Dateipfade werden bezogen auf die Xslt-Datei aufgelöst
Im Pdf-Modus gilt:
- Alle absoluten Web-Urls werden heruntergeladen und lokal im Session-Temp Ordner abgelegt
- Alle Dateien aus UNC-Pfaden werden in den Session-Temp-Folder kopiert.
- Alle lokal referenzierten Dateien werden beibehalten
- Alle relativen Dateipfade werden bezogen auf die Xslt-Datei aufgelöst
Argumente
- imageUri
die Adresse des Bildes, Url, Datei etc.
SelectNodesByXPathString(XPathNavigator rootEl, String xpath)
Verfügbar in: eo:iduCore
Gibt ein NodeSet als Ergebnis eines XPath Ausdruck zurück. Der XPath Ausdruck wird hier als Zeichenkette übergeben.
Argumente
- rootEl
nicht optionales Elemente, auf das die Selektion ausgeführt werden soll.
- xpath
der nicht optionale-XPath Ausdruck für die Menge
SelectSingleNodeByXPathString(XPathNavigator rootEl, String xpath)
Verfügbar in: eo:iduCore
Gibt einen Single-Node als Ergebnis eines XPath Ausdruck zurück. Der XPath Ausdruck wird hier als Zeichenkette übergeben.
Argumente
- rootEl
nicht optionales Elemente, auf das die Selektion ausgeführt werden soll.
- xpath
der nicht optionale-XPath Ausdruck für den Knoten
SetCounter(String key, Int32 value)
Verfügbar in: eo:iduCore
Setzt den Zähler auf den übergebenen Wert.
Argumente
- key
Id des Zählers (Zähler muss bereits unter diesem Schlüssel registriert sein)
- value
Wert auf den der Zähler gesetzt werden soll
Rückgabe
Aktuellen Wert des Zählers nach der Operation
SetForcePdfCompatibleURIs()
Verfügbar in: eo:iduCore
Erzwingen PDF-konformer URIs. Dies ist sinnvoll, wenn das Ausgabeformat
Html ist, das Ergebnisdokument aber nachträglich mit einer externen Lib
in ein PDF umgewandet werden soll (verwenden für HQPrint.net mit Lib HtmlRenderer).
StringJoin(String separator, Boolean skipEmtpyString, XPathNodeIterator stringNode)
Verfügbar in: eo:iduCore
Verbindet alle Werte aus der übergebenen Auflistung zu einer durch separator getrennten Zeichenfolge
Argumente
- separator
Trennzeichen
- skipEmtpyString
Leere Zeichenfolgen überspringen
- stringNode
Auflistung der Eingangsdaten, die verbunden werden sollen.
StringSplit(String separator, String value, Boolean trimEachValue)
Verfügbar in: eo:iduCore
Splittet einen String und gibt ein Nodeset mit den Einzelwerten zurück.
Leere Elemente werden immer übersprungen.
Argumente
- separator
Das Trennzeichen
- value
Der zu splittende Wert
- trimEachValue
Leerzeichen am Anfang und Ende der Einzelwerte entfernen
ToLower(String str)
Verfügbar in: eo:iduCore
Gibt einen String in Kleinbuchstaben zurück, nie null.
Argumente
ToUpper(String str)
Verfügbar in: eo:iduCore
Gibt einen String in Großbuchstaben zurück, nie null.
Argumente
TransformGeom(String geomString, Int32 targetEpsg)
Verfügbar in: eo:iduCore
Transformiert die übergebene Geometrie in die Zielprojektion
Argumente
- geomString
String EWKT oder Iwan
- targetEpsg
Zielprojektion
Rückgabe
transformierte Geometrie in EWKT
AppendPdfDocumentFromCardoPuzzleDocument(Int32 puzzleNodeId, Int32 ikxStoreId, String preferedXsltName)
Verfügbar in: eo:iduPdf
Ruft ein Dokument aus cardo.Puzzle ab und fügt dieses am Ende dieses Dokumentes mit an.
Wichtiger Hinweis: Bei falscher Verwendung besteht die Möglichkeit Endlosschleifen zu generieren!
Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.
Argumente
- puzzleNodeId
die Node-Id des Puzzle Dokumentes (oder Ordner), beachten Sie, dass Berechtigungen für den Zugriff vorhanden sein müssen.
- ikxStoreId
Ikx Store-Id
- preferedXsltName
optionaler, bevorzugter Name des Stylesheet
AppendPdfDocumentFromFile(String sourceFileName)
Verfügbar in: eo:iduPdf
Lädt ein vorhandenes Pdf - Dokument und fügt dieses am Ende des Ausgabe-Pdf mit ein. Die Datei muss aus Sicht des cardo Servers abrufbar sein.
Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.
Argumente
- sourceFileName
der (vollständige) Dateiname der Pdf Datei, um relative Dateinamen ordentlich aufzulösen, sollten Sie ce:ResolveImageUrlToLocalFile verwenden.
AppendPdfDocumentFromIkxStoredBlob(Int32 ikxStObjectDataId, Int32 ikxStoreId)
Verfügbar in: eo:iduPdf
Lädt ein vorhandenes Pdf - Dokument aus dem Blob Feld eines Ikx-Store und fügt dieses am Ende des Ausgabe-Pdf mit ein.
Beachten Sie, dass Berechtigungen geprüft werden (Read-Recht muss gegeben sein.)
Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.
Argumente
- ikxStObjectDataId
Ikx-Datentid des Blob Feldes
- ikxStoreId
Ikx Store-Id
CreatePdfAttachmentFromBytes(XPathNodeIterator sourceData, String localFileName, String htmlTocElementId, String description)
Verfügbar in: eo:iduPdf
Bettet Binärdaten als Anhang in das Ausgabe Pdf-Dokument ein.
Rückgabe ist ein <span .. mit dem "Büroklammer" Icon.
Argumente
- sourceData
die Bytes der Datei
- localFileName
der Dateiname (ohne Pfad, mit Erweiterung), für Anzeigezwecke
- htmlTocElementId
die Id des Html-Elementes im Inhaltsverzeichnis (optional)
- description
eine optionale Beschreibung der Datei
CreatePdfAttachmentFromFile(String sourceFileName, String alternativeFileName, String htmlTocElementId, String description)
Verfügbar in: eo:iduPdf
Bettet eine Datei als Anhang in das Ausgabe Pdf-Dokument ein.
Rückgabe ist ein <span .. mit dem "Büroklammer" Icon.
Beispiel
<xsl:value-of select="cePdf:CreatePdfAttachmentFromFile(
$pdfApplicationAttachmentFileName,
'Antrag.pdf',
'attachment_1_link',
'vollständiges Antragsdokument')" disable-output-escaping="yes"/> Antragsdokument
Argumente
- sourceFileName
der (vollständige) Dateiname des Anhangs, um relative Dateinamen ordentlich aufzulösen, sollten Sie ce:ResolveImageUrlToLocalFile verwenden.
- alternativeFileName
angezeigter Dateiname (Name.Extension) (optional)
- htmlTocElementId
die Id des Html-Elementes im Inhaltsverzeichnis (optional)
- description
eine optionale Beschreibung der Datei
CreatePdfAttachmentFromIkxStoredBlob(Int32 ikxStObjectDataId, Int32 ikxStoreId, String localFileName, String htmlTocElementId, String description)
Verfügbar in: eo:iduPdf
Bettet eine Blob-Eintrag aus einem Ikx-Datenspeicher als Anhang in das Ausgabe Pdf-Dokument ein.
Rückgabe ist ein <span .. mit dem "Büroklammer" Icon.
Argumente
- ikxStObjectDataId
Ikx-Datentid des Blob Feldes
- ikxStoreId
Ikx Store-Id
- localFileName
der Dateiname (ohne Pfad, mit Erweiterung), für Anzeigezwecke
- htmlTocElementId
die Id des Html-Elementes im Inhaltsverzeichnis (optional)
- description
eine optionale Beschreibung der Datei
SetMargin(Int32)
Verfügbar in: eo:iduPdf
Setzt die Seitenränder (für alle Seiten)
SetMargins(Int32 marginMmLeft, Int32 marginMmRight, Int32 marginMmTop, Int32 marginMmBottom)
Verfügbar in: eo:iduPdf
Setzt die Seitenränder(einzeln)
Argumente
- marginMmLeft
linker Rand in mm
- marginMmRight
rechter Rand in mm
- marginMmTop
oberer Rand in mm
- marginMmBottom
unterer Rand in mm
SetOrientation(String orientation)
Verfügbar in: eo:iduPdf
Ändern das Papier-Format
Argumente
- orientation
Landscape oder Portrait
SetPageSize(Int32 widhtMm, Int32 heightMm)
Verfügbar in: eo:iduPdf
Setzt die Ausgabegröße
Argumente
- widhtMm
Breite in mm
- heightMm
Höhe in mm
SetPageSizeByName(String pageSize)
Verfügbar in: eo:iduPdf
Setzt die Ausgabegröße anhand bekannter Namen (A0 ... A9)
Argumente
- pageSize
Enum-Wert, siehe TypeWellknownPageSize in http://schemas.webs.idu.de/cardo3/Button
SetPdfDocumentProperties(XPathNodeIterator node)
Verfügbar in: eo:iduPdf
Setzt die Dokument-Eigenschaften, wie Author, Title etc.
Argumente
- node
der Parametersatz für die Seiteneinstellungen, muss dem Element "ButtonPdfDocumentProperties" im Namespace "http://schemas.webs.idu.de/cardo3/Button" entsprechen.
SetPdfDocumentSecurity(XPathNodeIterator node)
Verfügbar in: eo:iduPdf
Setzt die Sicherheits-Optionen für das Pdf Dokument.
Argumente
- node
der Parametersatz für die Seiteneinstellungen, muss dem Element "ButtonPdfDocumentSecurity" im Namespace "http://schemas.webs.idu.de/cardo3/Button" entsprechen.
SetPdfHeaderAndFooter(XPathNodeIterator node)
Verfügbar in: eo:iduPdf
Setzt die Header und Footer Einstellungen für das Pdf Dokument.
Argumente
- node
der Parametersatz für die Seiteneinstellungen, muss dem Element "ButtonPdfHeaderAndFooter" im Namespace "http://schemas.webs.idu.de/cardo3/Button" entsprechen.
AppendDocumentFromIkxStoredBlob(Int32 ikxStObjectDataId, Int32 ikxStoreId)
Verfügbar in: eo:iduDocX
Lädt ein vorhandenes Dokument aus dem Blob Feld eines Ikx-Store.
Beachten Sie, dass Berechtigungen geprüft werden (Read-Recht muss gegeben sein.)
Gibt eine Unique-Id zurück, die im Element <attachmentReference> als Attribut uniqueId eingesetzt werden kann.
Wird mehrfach eine der AppenndDocument -Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.
Argumente
- ikxStObjectDataId
Ikx-Datentid des Blob Feldes
- ikxStoreId
Ikx Store-Id
AppendPdfDocumentFromCardoPuzzleDocument(Int32 puzzleNodeId, Int32 ikxStoreId, String preferedXsltName)
Verfügbar in: eo:iduDocX
Ruft ein Dokument aus cardo.Puzzle ab und fügt dieses am Ende dieses Dokumentes mit an.
Wichtiger Hinweis: Bei falscher Verwendung besteht die Möglichkeit Endlosschleifen zu generieren!
Gibt eine Unique-Id zurück, die im Element <attachmentReference> als Attribut uniqueId eingesetzt werden kann.
Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.
Argumente
- puzzleNodeId
die Node-Id des Puzzle Dokumentes (oder Ordner), beachten Sie, dass Berechtigungen für den Zugriff vorhanden sein müssen.
- ikxStoreId
Ikx Store-Id
- preferedXsltName
optionaler, bevorzugter Name des Stylesheet
CreateAttachmentFromFile(String sourceFileName, String)
Verfügbar in: eo:iduDocX
Lädt ein Dokument und fügt dieses am Ende des Ausgabe mit ein. Die Datei muss aus Sicht des cardo Servers abrufbar sein.
Gibt eine Unique-Id zurück, die im Element <attachmentReference> als Attribut uniqueId eingesetzt werden kann.
Wird mehrfach eine der AppendDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.
Argumente
- sourceFileName
der (vollständige) Dateiname der Pdf Datei, um relative Dateinamen ordentlich aufzulösen, sollten Sie ce:ResolveImageUrlToLocalFile verwenden.
SetDocXHeaderAndFooter(XPathNodeIterator node)
Verfügbar in: eo:iduDocX
Setzt die Header und Footer Einstellungen für das DocX Dokument.
Argumente
- node
der Parametersatz für die Seiteneinstellungen, muss dem Element "ButtonDocXHeaderAndFooter" im Namespace "http://schemas.webs.idu.de/cardo3/Button" entsprechen.
SetMargin(Int32)
Verfügbar in: eo:iduDocX
Setzt die Seitenränder (für alle Seiten)
SetMargins(Int32 marginMmLeft, Int32 marginMmRight, Int32 marginMmTop, Int32 marginMmBottom)
Verfügbar in: eo:iduDocX
Setzt die Seitenränder(einzeln)
Argumente
- marginMmLeft
linker Rand in mm
- marginMmRight
rechter Rand in mm
- marginMmTop
oberer Rand in mm
- marginMmBottom
unterer Rand in mm
SetOrientation(String orientation)
Verfügbar in: eo:iduDocX
Ändern das Papier-Format
Argumente
- orientation
Landscape oder Portrait
SetPageSize(Int32 widhtMm, Int32 heightMm)
Verfügbar in: eo:iduDocX
Setzt die Ausgabegröße
Argumente
- widhtMm
Breite in mm
- heightMm
Höhe in mm
SetPageSizeByName(String pageSize)
Verfügbar in: eo:iduDocX
Setzt die Ausgabegröße anhand bekannter Namen (A0 ... A9)
Argumente
- pageSize
Enum-Wert, siehe TypeWellknownPageSize in http://schemas.webs.idu.de/cardo3/Button
AddLayerByTagsToLayerList(XPathNodeIterator oldLayerList, String tagNames)
Verfügbar in: eo:iduCore
Fügt Layer, die via LayerTag(s) ermittelt werden, an eine bestehende LayerList an
Argumente
- oldLayerList
die bisherige Layerliste
- tagNames
ein oder mehrere Layer-Tags - alle Ebenen mit den Tags werden hinten angefügt, die einzelnen Tags sind durch ein | zu trennen
CreateLegendImageByLayerTag(String layerTag)
Verfügbar in: eo:iduCore
Gibt die URL zum Legendenbild für eine Ebene, die via Tag übergeben wird, aus
Argumente
- layerTag
ein Layer-Tags - die Legende wird für die erste Ebene mit diesem Tag erzeugt
GetCurrentApplicationRootUrl(Boolean absolute, Boolean withPathModifier)
Verfügbar in: eo:iduCore
Gibt die Url zum Anwendungsroot zurück (z.B. net3), kann kombiniert werden um z.B. den OGC(sl).ashx Handler zu adressieren.
Bsp.: für die Rückgabe http://localhost:81/net3/
Argumente
- absolute
vollständige absolute Url zurückgeben, sonst relativ
- withPathModifier
die evtl. vorhandnen Pfad-Modifier mit zurückgeben oder nicht
Rückgabe
Die absolute oder relative Adresse zum Root der Anwendung, immer mit endendem Slash
GetFileIconByName(String fileName)
Verfügbar in: eo:iduCore
Gibt eine relative Url zum Abrufen des Icons für einen Dateityp zurück, kann mit GetCurrentApplicationRootUrl kombiniert werden.
Argumente
- fileName
Ein Dateiname (mit oder ohne Pfad)
Rückgabe
die Url zum Resource-Handler (res.ashx?Res=xx)
GetLayerListFromMyMap(Int32 myMapId)
Verfügbar in: eo:iduCore
Extrahiert die Sichtbaren Ebene aus der angegebenen "Meine Karte". Die Layerliste ist sortiert und enthält die internen Namen (L1).
Hinweis: der Aufrufer muss Rechte an der Karte haben.
Argumente
- myMapId
die Id einer "Meine" Karte, an der der Aufrufer Berechtigungen hat
GetLayerTag(String layerName)
Verfügbar in: eo:iduCore
Ermittelt den Anwendungsname (LayerTag) der Ebene.
Argumente
- layerName
Name der Ebene (LXXX)
Rückgabe
LayerTag oder null, wenn kein LayerTag vergeben
GetLayerTitle(String layerName)
Verfügbar in: eo:iduCore
Ermittelt den Titel der Ebene.
Argumente
- layerName
Name der Ebene (LXXX)
Rückgabe
Titel der Ebene
GetPuzzleDataByQPzlId(String qPzlId)
Verfügbar in: eo:iduCore
Gibt das XML-Dokument zu einem beliebigen Puzzle-Dokument heraus (AllAvailableContent).
Argumente
- qPzlId
Die Qualified ID des Dokuments.
GetPuzzleDataForNode(Int32 puzzleNodeId, Int32 ikxStoreId)
Verfügbar in: eo:iduCore
Gibt das XML-Dokument zu einem beliebigen Puzzle-Dokument heraus
Mit allem was es gibt dran (AllAvailableContent)
Argumente
- puzzleNodeId
Id des PuzzleNodes
- ikxStoreId
Id des IKX-Stores
Rückgabe
das XML-Document
GetVisibleLayerListFromView(Int32 viewId)
Verfügbar in: eo:iduCore
Gibt die sortierte Layerliste der sichtbaren Ebenen an denen der Benutzer das LayerRendering Recht hat aus dem übergeben View zurück.
Ist die ViewId kleiner gleich 0, wird der erste cardo Ebenenbaum verwendet.
Argumente
- viewId
Die Id des abzurufenden Views, kleiner 0 => nimm den 1. cardo Ebenenbaum.
Hinweise
Die Aufrufe werden in der Instanz gecached
IkxCheckEntityExists(String classId, String entityId)
Verfügbar in: eo:iduCore
Prüft, ob die angegebene Entität in der angegebenen Klasse existiert
Argumente
- classId
ID der Klasse, zu der die Entität gehört
- entityId
ID der Entität
Rückgabe
true - Entität existiert
IkxGetClassDescription(String classId)
Verfügbar in: eo:iduCore
Gibt die Beschreibung für die Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.
Argumente
Rückgabe
Die Beschreibung der Klasse in der aktuell eingestellten Sprache
Hinweise
Die Klasse / Entität muss vorhanden sein.
IkxGetClassLabel(String classId)
Verfügbar in: eo:iduCore
Gibt den Anzeigetitel für die Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.
Argumente
Rückgabe
Der Label der Klasse in der aktuell eingestellten Sprache
Hinweise
Die Klasse muss vorhanden sein.
IkxGetClassXml(String classId)
Verfügbar in: eo:iduCore
Ruft die Struktur einer IkxClass in Form der Ikx-Klassenexport Xml Beschreibung ab.
Argumente
- classId
die Id einer vorhandenen Klasse im aktuellen Store
IkxGetEntityDescription(String classId, String entityId)
Verfügbar in: eo:iduCore
Gibt die Beschreibung für die Entität Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.
Argumente
Rückgabe
Die Beschreibung der Klasse in der aktuell eingestellten Sprache
Hinweise
Die Klasse / Entität muss vorhanden sein.
IkxGetEntityGroupName(String classId, String entityId)
Verfügbar in: eo:iduCore
Gibt den Namen der Feldgruppe für die Entität Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.
Argumente
Rückgabe
Die Beschreibung der Klasse in der aktuell eingestellten Sprache
Hinweise
Die Klasse / Entität muss vorhanden sein.
IkxGetEntityLabel(String classId, String entityId)
Verfügbar in: eo:iduCore
Gibt den Anzeigetitel für die Entität mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.
Argumente
- classId
ID der Klasse, zu der die Entität gehört
- entityId
ID der Entität
Rückgabe
Der Label der Entität in der aktuell eingestellten Sprache
Hinweise
Die Entität muss vorhanden sein.
IkxGetEntitySortHint(String classId, String entityId)
Verfügbar in: eo:iduCore
Gibt ein Sortierfeld zurück, beachtet dabei auch die Gruppensortierung
Argumente
IkxGetEntityTabName(String classId, String entityId)
Verfügbar in: eo:iduCore
Gibt den Namen der Tab-Seite für die Entität Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.
Argumente
Rückgabe
Die Beschreibung der Klasse in der aktuell eingestellten Sprache
Hinweise
Die Klasse / Entität muss vorhanden sein.
IkxHasAtLeastOneEntityInGroupEffectiveRight(String classId, String tabSort, String tabName, String groupSort, String groupName, IkxRightFlags rightToCheck)
Verfügbar in: eo:iduCore
Ermittelt, ob in einer Gruppe ein Recht auf mind. eine Entity vorhanden ist
Argumente
- classId
Id der Klasse
- tabSort
Tab-Sortierung
- tabName
Tab-Name
- groupSort
Gruppen-Sortierung
- groupName
Gruppen-Name
- rightToCheck
Recht, das zu prüfen ist
IkxHasEffectiveRight(String classId, String entityId, IkxRightFlags rightToCheck)
Verfügbar in: eo:iduCore
Ermittelt, ob der aktuelle Nutzer die übergebenen Rechte an der Entity hat
Argumente
- classId
Id der Klasse
- entityId
Id der Entity
- rightToCheck
Recht, das zu prüfen ist
IkxIsEntityMeaningSet(XPathNodeIterator givenMeaning, String toCompare)
Verfügbar in: eo:iduCore
Prüft, auf givenMeaning.HasFlag(toCompare), Beide Werte werden in MDEntityMeanings konvertiert.
Argumente
IkxIsStoreSelected()
Verfügbar in: eo:iduCore
Gib true zurück, wenn aktuell ein Ikx Datenspeicher selektiert ist. Siehe auch Hinweis zu IkxSelectIkxStore.
IkxRenderMimeTypeValueToHtml(String kindOfMimeType, String value, String additionalData)
Verfügbar in: eo:iduCore
Generieren des Html-Code für ein Datenfeld mit MimeType Handler, aufgerufen wird die RenderToHtml des installierten MimeType-Handler.
Argumente
- kindOfMimeType
Der .Net Typename des MimeType
- value
der Werte
- additionalData
Zusatzdaten
IkxSelectIkxStore(Int32 ikxStoreId)
Verfügbar in: eo:iduCore
Wählt einen Ikx Datenspeicher aus, der für alle folgenden Ikx** Aufrufe verwendet wird.
Diese Methode muss vor dem Aufruf der anderen Ikx** Methoden aufgerufen werden.
Es kann sein, dass die Umgebung bereits einen Store selektiert hat, dies ist Abhängig vom Modul in dem diese Ikx Erweiterung eingesetzt wird.
Zurückgegeben wird die vorherige Ikx-Store-id
Argumente
IsAnonymous()
Verfügbar in: eo:iduCore
Gibt an, ob der Aufruf der aktuellen Abarbeitung als Anonymous erfolgt.
IsUserIsInRole(String roleName)
Verfügbar in: eo:iduCore
Gibt true zurück, wenn der aktuell angemeldete Benutzer Mitglied in der übergebenen Gruppe ist
Argumente
UserDescription(String userName)
Verfügbar in: eo:iduCore
Gibt die Beschreibung zum übergebenen Benutzernamen zurück.
Argumente
UserName()
Verfügbar in: eo:iduCore
Gibt den Login-Namen des aktuellen Benutzers zurück.
XPathToNode(IXPathNavigable root, Object param)
Verfügbar in: eo:iduCore
Versucht, den übergebenen Wert wie nachfolgend aufgelistet zu interpretieren:
- ist der Parameter bereits ein XML-Node -> unverändert zrückgegeben
- ist der Parameter ein Pfad und ist der Knoten auf den verwiesen wird nicht leer -> Knoten zurück
- ist der Parameter ein String und als XPath interpretierbar -> Knoten zurück
- ist der Parameter ein String aber kein XPath -> fixer Wert -> als String zurück
ansonsten String "XPathToNode:emptyResult" zurück zur Erkennung leere Ergebnismenge
Argumente
- root
Basisknoten, typischerweise /
- param
auszuwertender Parameter
Rückgabe
siehe oben