Promotic
WikipediaLinkedInYoutubeTwitterFacebook

FindViewers - metoda objektu Pm

Popis:
Metoda umožňuje získat seznam prohlížečů objektů podle zadaných kritérií. Seznam je zejména vhodný pro následné zobrazení nabídky metodou SelectionDialog. Umožňuje pohodlně vytvářet uživatelské nabídky s proměnlivým a parametrizovatelným obsahem. Nabídky mohou mít globální charakter se seznamem všech dostupných objektů aplikace a/nebo lze vytvářet nabídky orientované pouze na část aplikace (technologie) pomocí logických skupin.
Syntaxe:
FindViewers(sFilter As String, sExpression As String, sParams As String) As Array
Volání:
data = Pm.FindViewers(sFilter, sExpression, sParams)
Parametry:
sFilter(String) Umožňuje filtrovat objekty a jejich prohlížeče. Například "groups:menu;viewers:panel,alarm_state,alarm_history;viewertype:0;". Přednastavená hodnota je "viewers:all;viewertype:0;"
groups - Filtrace podle logické skupiny prohlížečů (objektů). Například "groups:menu;".
viewers (nepovinné) - Filtrace podle typů požadovaných prohlížečů. Například "viewers:panel,alarm_state,alarm_history;".
all (přednastaveno) - Jakákoliv prohlížečka.
workspace - Prohlížečka objektu PmWorkspace s pracovní plochou.
panel - Prohlížečka objektu PmPanel s uživatelskou grafikou.
report - Prohlížečka objektu PmReport s přehledovými a tiskovými sestavami.
alarm_state - Prohlížečka objektu PmAlarmEvent - stav alarmů.
alarm_history - Prohlížečka objektu PmAlarmEvent - historie alarmů.
event - Prohlížečka objektu PmAlarmEvent - historie eventů.
viewertype (nepovinné) - Typ filtrace podle toho zda jsou prohlížeče určené pro zobrazení v lokální aplikaci nebo pro WEB. Pokud se nezadá, pak se automaticky nastavuje podle toho, zda je tato metoda volána v lokální aplikaci nebo na WEBu - normálně se tedy tato volba nemusí zadávat.
1 - Jen prohlížeče určené pro lokální aplikaci.

Zatím u prohlížečů (např. u objektů PmPanel) nelze říct že nejsou určené pro lokální použití a tedy tato volba nic neodfiltruje.

2 - Jen prohlížeče určené pro WEB.

Ve výsledném seznamu budou jen ty prohlížeče, které jsou povoleny pro WEB sdílení. Standardně se objekt (např. PmPanel) povoluje do WEBu konfigurátorem Povolit jako WEB komponentu v záložce Web Server.

sExpression(String) Rezervováno, musí zde být prázdný řetězec ("").
sParams(String) Určuje formát výstupních dat. Například "headers:title;columns:path,title;lang:cs;". Přednastavená hodnota je "headers:title;columns:path,title;"
headers (nepovinné) - Určuje, zda výsledný seznam bude obsahovat (první řádek) i lokalizované názvy sloupců pro následné zobrazení.
title (přednastaveno) - První řádek výsledného seznamu bude obsahovat lokalizované názvy sloupců pro následné zobrazení.
columns (nepovinné) - Seznam identifikátorů sloupců výsledného seznamu (oddělovač je čárka ',').
path (přednastaveno) - Úplná cesta k prohlížečce objektu (s případným upřesněním prohlížečky například #state, umožňující otevřít prohlížečku pomocí metody Otevření prohlížečky objektu). Tento sloupec se pro potřeby následného zobrazení nabídky pomocí metody SelectionDialog uvádí vždy jako první a při zobrazení nabídky je neviditelný. Další sloupce už jsou v nabídce viditelné.
title (přednastaveno) - Lokalizovaný text spojený s daným prohlížečem nalezeného objektu (Title), určený k zobrazení v nabídce.
alstate3 - Počet alarmů ve stavu aktivní nekvitovaný (červený) v alarmní skupině.
alstate2 - Počet alarmů ve stavu aktivní kvitovaný (žlutý) v alarmní skupině.
alstate1 - Počet alarmů ve stavu neaktivní nekvitovaný (modrý) v alarmní skupině.
alhoot - Počet houkajících alarmů v alarmní skupině.
lang (nepovinné) - Určuje národní jazyk, pro který budou vyhodnocené lokalizované texty. Jazyk je určen textovým identifikátorem, např. "cs", "sk", "en" atd. - viz Jazyky s plnou podporou v systému PROMOTIC. Neuvede-li se, použije se právě používaný jazyk prohlížeče - normálně se tedy tato volba nemusí zadávat. Viz konfigurátor "PmRoot > Aplikace > Hlavní jazyk runtime".
Vrácená hodnota:
Výsledný seznam je v podobě 2-rozměrného pole, kde řádky představují jednotlivé nalezené prohlížeče objektů.
Poznámka:
Řádky odpovídají jednotlivým nalezeným prohlížečům objektů podle zadaných filtračních kritérií. Sloupce jsou určeny položkou columns v parametru sParams.

Základní formát výsledného seznamu je, že v prvním sloupci je úplná cesta k nalezené prohlížečce objektu (s případným upřesněním prohlížečky například #state, umožňující otevřít prohlížečku pomocí metody Otevření prohlížečky objektu) a v druhém sloupci je lokalizovaný text spojený s daným prohlížečem nalezeného objektu (k zobrazení v nabídce). Odpovídá nastavení "columns:path,title;", což je implicitní hodnota této položky. První řádek bude obsahovat lokalizované záhlaví s nadpisy sloupců. Odpovídá nastavení "headers:title;", což je implicitní hodnota této položky.

 
Metodu lze volat i v událostech grafických prvků pro Web Obrazy. Volání této metody na WEBu způsobí vnitřní XML komunikaci se serverem, takže se metoda ve skutečnosti volá na serveru a jen vstupní a výstupní data se přenesou přes komunikaci.
Viz také:
Příklad1:
Získání seznamu všech prohlížečů uživatelské grafiky, které jsou nabídnuty do globální nabídky v rámci logické skupiny menu, se základním zobrazením (cesta k prohlížečce a uživatelský lokalizovaný název). Nabídka bude včetně prvního řádku s vygenerovanými názvy sloupců.

Tento skript je vyvolán v události grafického prvku (např. v události PmiButton.onButtonUp). Pomocí vlastnosti PmiRoot.ClientType se dosáhne toho, že v lokálním obrazu bude nabídka všech lokálních obrazů a ve WEB obrazu bude nabídka všech WEB obrazů.

Dim a
a = Pm.FindViewers("groups:menu;viewers:panel;", "", "")
Příklad2:
Získání seznamu všech prohlížečů stavů alarmů, které jsou nabídnuty do globální nabídky v rámci logické skupiny menu, s podrobným zobrazením počtů alarmů v jednotlivých stavech. Nabídka bude včetně prvního řádku s vygenerovanými názvy sloupců. Lokalizované texty budou vyhodnoceny pro češtinu.
Dim a
a = Pm.FindViewers("groups:menu;viewers:alarm_state;", "", "columns:path,title,alstate3,alstate2,alstate1,alhoot;lang:cs;")
Další příklady:
Navigace:
 
- Pm
 
- Abs
- Cos
- E
- Exp
- FindViewers
 
 
- LN2
- PI
- Pow
- Sin
- Tan
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice