Changes: API FrameScriptObject GetObjectType

Revision as of 16:22, 17 July 2008

Main Menu

Synopsis

string frameType = Frame:GetFrameType();

Description

This returns the type of the frame the GetFrameType() method is used on.

It will return a string of the name of the Frame(-derived) object. For a complete list see object types

Return values

frameType: String - The name of the type, ie. "Frame"

Examples

local frameType = QuestLogCollapseAllButton:GetFrameType();

The above should return the string "Button" in local variable frameType.

Notes

This method may not exist for all Frames.

@@ Line 1: / Line 1: @@
+{{widgetmethod}}
-<center>'''GetFrameType''' ''-Documentation by [[user:Darjk|Darjk]]-''</center>
+== Synopsis ==
-This returns the type of frame that 'this' object is.
-local frameType = this:GetFrameType();
+string frameType = Frame:GetFrameType();
-== Parameters ==
+== Description ==
-=== Arguments ===
+This returns the type of the frame the GetFrameType() method is used on.
-:;nil
+It will return a string of the name of the Frame(-derived) object. For a complete list see [[API Object Types|object types]]
-=== Returns ===
+== Return values ==
 :;frameType : String - The name of the type, ie. "Frame"
-== Example ==
+== Examples ==
- local frameType = getglobal("QuestLogCollapseAllButton"):GetFrameType();
+ local frameType = QuestLogCollapseAllButton:GetFrameType();
-====Result====
-frameType = "Button"
-==Details==
-'this' is any Frame or Frame Derivative widget (also known as objects, or elements).
-The purpose of this function is so you can find out what the frame type is.
-It can return,  "Frame", "Button", "EditBox", "ScrollingFrame", etc.  Basically any widget that is derived from the original Frame widget.
+The above should return the string "Button" in local variable frameType.
-"FontString", "Texture", etc are NOT derived from the type Frame,  but are derived from the LayoutFrame, so this function does not work with those objects.
+== Notes ==
-<br><center><i>Last updated: Patch 1.9.2</i></center>
+* This method may not exist for all Frames.
-----
-__NOTOC__
-{{Template:WoW API}}
-[[Category:API Sub Functions|Empty Template]]