Struct sap_scripting::types::GuiSession

pub struct GuiSession { /* private fields */ }

The GuiSession provides the context in which a user performs a certain task such as working with a transaction. It is therefore the access point for applications, which record a user’s actions regarding a specific task or play back those actions. GuiSession extends GuiContainer. The type prefix is ses, the name is ses plus the session number in square brackets.

Trait Implementations

impl GuiComponentMethods<GuiSession> for GuiSession

fn container_type(&self) -> Result<bool>

This property is TRUE, if the object is a container and therefore has the Children property.

fn id(&self) -> Result<String>

An object id is a unique textual identifier for the object. It is built in a URLlike formatting, starting at the GuiApplication object and drilling down to the respective object.

fn name(&self) -> Result<String>

The name property is especially useful when working with simple scripts that only access dynpro fields. In that case a field can be found using its name and type information, which is easier to read than a possibly very long id. However, there is no guarantee that there are no two objects with the same name and type in a given dynpro.

fn kind(&self) -> Result<String>

The type information of GuiComponent can be used to determine which properties and methods an object supports. The value of the type string is the name of the type taken from this documentation.

fn kind_as_number(&self) -> Result<i64>

While the Type property is a string value, the TypeAsNumber property is a long value that can alternatively be used to identify an object’s type . It was added for better performance in methods such as FindByIdEx. Possible values for this property are taken from the GuiComponentTypeenumeration.

impl GuiContainerMethods<GuiSession> for GuiSession

fn find_by_id<S>(&self, id: S) -> Result<SAPComponent>where S: AsRef<str>,

Search through the object’s descendants for a given id. If the parameter is a fully qualified id, the function will first check if the container object’s id is a prefix of the id parameter. If that is the case, this prefix is truncated. If no descendant with the given id can be found the function raises an exception.

fn children(&self, n: u32) -> Result<GuiSession>

This collection contains all direct children of the object.

impl HasDispatch<GuiSession> for GuiSession

fn get_idispatch(&self) -> &IDispatch

Get the IDispatch object for low-level access to this component.