Struct sap_scripting::types::GuiComponent

pub struct GuiComponent { /* private fields */ }

This interface resembles GuiVContainer. The only difference is that it is not intended for visual objects but rather administrative objects such as connections or sessions. Objects exposing this interface will therefore support GuiComponent but not GuiVComponent. GuiContainer extends the GuiComponent Object.

Trait Implementations

impl From<GuiComponent> for SAPComponent

fn from(value: GuiComponent) -> Self

Converts to this type from the input type.

impl GuiComponentMethods<GuiComponent> for GuiComponent

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<GuiComponent> for GuiComponent

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<GuiComponent> for GuiComponent

fn get_idispatch(&self) -> &IDispatch

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