onReportRequest - událost objektu PmReport

Popis:

Událost je vyvolána při každém požadavku získání sestavy (tzn. když se má sestava zobrazit v lokálním nebo Web okně, když se volá metoda SaveToFile nebo SaveToString). Událost slouží k případné aktualizaci sestavy (viz automatický způsob aktualizace popsaný v PmReport).

Parametry:

pMe	(Object) Reference na PROMOTIC objekt, ve kterém daná událost vzniká.
pEvent	(Object) Reference na objekt popisující podrobněji informace o dané události. pEvent.Context - (Object) Obsahuje referenci na objekt s dodatečnými informacemi o kontextu volání (např. uživatel). pEvent.Context.User - (Object) vlastnost s referencí na objekt User, ve kterém jsou podrobnější informace o uživateli (lokálním nebo síťovém), který metodu zavolal. Lze využít například: - ke chránění metody na konkrétního přihlášeného uživatele nebo skupinu uživatelů. - k uchování a čtení stavových privátních dat uživatele pomocí metod SetPrivateData a GetPrivateData. Upozornění! Aby v podobjektu User byla věrohodná hodnota je nutno, aby v příslušném oprávnění WebRead nebyly pseudo skupiny $ANY a $ANY_NET (tzn. aby při otevření Web stránky musel být přihlášen uživatel). pEvent.Context.Language - (String) vrací informaci o požadovaném národním jazyce, ve kterém jsou požadovány případné textové výstupy metody (vhodné zejména při vyvolávání metody z Web obrazů). Jazyk je určen textovým identifikátorem, např. "cs", "sk", "en" atd. - viz Jazyky s plnou podporou v systému PROMOTIC. pEvent.Pars - (Object) Obsahuje referenci na objekt s dodatečnými parametry sestavy, dodaných při otevření prohlížečky (Viz Výchozí hodnota sParams nebo Otevření prohlížečky objektu). Každý jednotlivý parametr je tvořen identifikátorem (název) a hodnotou. Těmito parametry je možno parametrizovat obsah sestavy (aktualizace) při otevření prohlížečky. Jednak je možno na základě těchto parametrů parametrizovat načítaná data ve vlastní události onReportRequest a také lze hodnoty těchto parametrů předávat přímo do sestavy v podobě klíčových slov. K jednotlivým parametrům lze přistupovat pomocí následujících metod tohoto objektu: pEvent.Pars.GetValueAt - Syntaxe: GetValueAt(sId As String) As String. Metoda umožňuje získat hodnotu jednoho parametru podle jeho identifikátoru (jména). V případě, že daný parametr neexistuje, je vrácena hodnota Empty. pEvent.Modify - (Long) Výstupní hodnota indikující, zda došlo k aktualizaci klíčových hodnot nebo souboru se vzorem a zda má být sestava znovu vytvořena (viz metoda MakeReport). 0 - Nedošlo ke změně, výsledná sestava se nebude znovu vytvářet (použije se sestava z cache objektu PmReport). 1 - Došlo ke změně, výslednou sestavu je nutno znovu vytvořit.

pMe

(Object) Reference na PROMOTIC objekt, ve kterém daná událost vzniká.

pEvent

(Object) Reference na objekt popisující podrobněji informace o dané události.

pEvent.Context - (Object) Obsahuje referenci na objekt s dodatečnými informacemi o kontextu volání (např. uživatel).

pEvent.Context.User - (Object) vlastnost s referencí na objekt User, ve kterém jsou podrobnější informace o uživateli (lokálním nebo síťovém), který metodu zavolal. Lze využít například:

- ke chránění metody na konkrétního přihlášeného uživatele nebo skupinu uživatelů.

- k uchování a čtení stavových privátních dat uživatele pomocí metod SetPrivateData a GetPrivateData.

Upozornění! Aby v podobjektu User byla věrohodná hodnota je nutno, aby v příslušném oprávnění WebRead nebyly pseudo skupiny $ANY a $ANY_NET (tzn. aby při otevření Web stránky musel být přihlášen uživatel).

pEvent.Context.Language - (String) vrací informaci o požadovaném národním jazyce, ve kterém jsou požadovány případné textové výstupy metody (vhodné zejména při vyvolávání metody z Web obrazů). Jazyk je určen textovým identifikátorem, např. "cs", "sk", "en" atd. - viz Jazyky s plnou podporou v systému PROMOTIC.

pEvent.Pars - (Object) Obsahuje referenci na objekt s dodatečnými parametry sestavy, dodaných při otevření prohlížečky (Viz Výchozí hodnota sParams nebo Otevření prohlížečky objektu). Každý jednotlivý parametr je tvořen identifikátorem (název) a hodnotou. Těmito parametry je možno parametrizovat obsah sestavy (aktualizace) při otevření prohlížečky. Jednak je možno na základě těchto parametrů parametrizovat načítaná data ve vlastní události onReportRequest a také lze hodnoty těchto parametrů předávat přímo do sestavy v podobě klíčových slov.

K jednotlivým parametrům lze přistupovat pomocí následujících metod tohoto objektu:

pEvent.Pars.GetValueAt - Syntaxe: GetValueAt(sId As String) As String. Metoda umožňuje získat hodnotu jednoho parametru podle jeho identifikátoru (jména). V případě, že daný parametr neexistuje, je vrácena hodnota Empty.

pEvent.Modify - (Long) Výstupní hodnota indikující, zda došlo k aktualizaci klíčových hodnot nebo souboru se vzorem a zda má být sestava znovu vytvořena (viz metoda MakeReport).

0 - Nedošlo ke změně, výsledná sestava se nebude znovu vytvářet (použije se sestava z cache objektu PmReport).

1 - Došlo ke změně, výslednou sestavu je nutno znovu vytvořit.

Příklad:

Příklad na vyčtení dvou pojmenovaných parametrů (par1 a par2) dodaných při otevření prohlížečky a jejich předání do aktualizace sestavy (transformace vzoru) v podobě klíčových slov.

pEvent.Modify = 1

pMe.SetKeyValue "kPar1", pEvent.Pars.GetValueAt("par1")

pMe.SetKeyValue "kPar2", pEvent.Pars.GetValueAt("par2")

Dokumentace SCADA systému PROMOTIC 8.3.20 - MICROSYS, spol. s r.o.

Chci zaslat připomínku k této stránce Kontakt na zodpovědnou osobu

Navigace:

- SCADA/HMI systém PROMOTIC

- Obsah dokumentace

- Objekty systému PROMOTIC

- PROMOTIC objekty

- PmReport

- MakeReport

- onReportRequest