FindViewers - metoda objektu Pm

Popis:

Vrací seznam prohlížečů objektů podle zadaných kritérií.
Seznam je zejména vhodný pro Otevření prohlížeče pro výběr volby z nabídky. 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:

Array FindViewers(String sFilter, String sExpression, String 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;". Výchozí 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č. workspace - Prohlížeč objektu PmaWorkspace s pracovní plochou. panel - Prohlížeč objektu PmaPanel s uživatelskou grafikou. report - Prohlížeč objektu PmaReport s přehledovými a tiskovými reporty. alarm_state - Prohlížeč objektu PmaAlarmGroup - stavy alarmů. alarm_history - Prohlížeč objektu PmaAlarmGroup - historie alarmů. event - Prohlížeč objektu PmaEventGroup - 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 nastavuje automaticky podle toho, zda je tato metoda volána v lokální aplikaci nebo na Webu - a proto se normálně tato volba nemusí zadávat. 1 - Pouze prohlížeče určené pro lokální aplikaci. Prozatím u prohlížečů (např. u objektů PmaPanel) nelze říct že nejsou určené pro lokální použití a proto tato volba nic neodfiltruje. 2 - Pouze prohlížeče určené pro Web. Ve výsledném seznamu budou pouze ty prohlížeče, které jsou povoleny pro Web sdílení. Standardně se objekt (např. PmaPanel) povolí do Webu v konfigurátoru "Povolit jako Web komponentu" v kartě "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;". Výchozí hodnota je "headers:title;columns:path,title;" headers (nepovinné) - Určuje, zda výsledný seznam bude obsahovat (na prvním řádku) i názvy sloupců (lokalizované texty) pro následné zobrazení. title (přednastaveno) - První řádek výsledného seznamu bude obsahovat názvy sloupců (lokalizované texty) 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či objektu (s případným upřesněním prohlížeče například #state, které umožňuje otevřít prohlížeč metodou CreateView). Tento sloupec se pro potřeby následného zobrazení nabídky 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ý pro zobrazení v nabídce. alstate3 - Počet alarmů ve stavu aktivní nekvitovaný [červený] ve skupině alarmů. alstate2 - Počet alarmů ve stavu aktivní kvitovaný [žlutý] ve skupině alarmů. alstate1 - Počet alarmů ve stavu neaktivní nekvitovaný [modrý] ve skupině alarmů. alhoot - Počet houkajících alarmů ve skupině alarmů. 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. Pokud není nastaveno, pak se použije právě používaný jazyk prohlížeče - obvykle se tedy tato volba nemusí zadávat. Viz konfigurátor "PmaRoot > Aplikace > Hlavní jazyk runtime".

Vrácená hodnota:

Výsledný seznam je 2-rozměrné pole (objekt PmArray pro JavaScript nebo datový typ Array pro VBScript), kde každý řádek představuje nalezený prohlíž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ému prohlížeči objektu (s případným upřesněním prohlížeče například #state, umožňující otevřít prohlížeč metodou CreateView) a v druhém sloupci je lokalizovaný text spojený s daným prohlížečem nalezeného objektu (pro zobrazení v nabídce). To odpovídá nastavení "columns:path,title;", což je výchozí hodnota této položky. První řádek bude obsahovat záhlaví (lokalizovaný text) s nadpisy sloupců. To odpovídá nastavení "headers:title;", což je výchozí hodnota této položky.

Tato metoda je funkční i ve Web obrazech. 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 pouze vstupní a výstupní data se přenesou přes komunikaci.

Příklad1:

Získá seznam 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či 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 Pmg objektu (např. v události PmgButton.onButtonUp). Pomocí vlastnosti PmgRoot.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ů.

JavaScriptVBScriptVyber a zkopíruj do schránky



var aViewers = Pm.FindViewers("groups:menu;viewers:panel;", "", "");

Příklad2:

Získá seznam 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 angličtinu.

Promotic