| Server IP : 121.121.20.254 / Your IP : 216.73.216.202 Web Server : Microsoft-IIS/10.0 System : Windows NT WEB-SERVER 10.0 build 20348 (Windows Server 2022) AMD64 User : IUSR ( 0) PHP Version : 8.3.28 Disable Function : NONE MySQL : ON | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/Program Files/LibreOffice/help/en-US/text/shared/guide/ |
Upload File : |
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<base href="../../../../">
<noscript><meta http-equiv="refresh" content="0; URL=../../../../en-US/noscript.html"></noscript>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Development Tools</title>
<link rel="shortcut icon" href="media/navigation/favicon.ico">
<link type="text/css" href="normalize.css" rel="Stylesheet">
<link type="text/css" href="prism.css" rel="Stylesheet">
<link type="text/css" href="default.css" rel="Stylesheet">
<script type="text/javascript" src="polyfills.js"></script><script type="text/javascript" src="languages.js"></script><script type="text/javascript" src="en-US/langnames.js"></script><script type="text/javascript" src="flexsearch.debug.js"></script><script type="text/javascript" src="prism.js"></script><script type="text/javascript" src="help2.js" defer></script><script type="text/javascript" src="a11y-toggle.js" defer></script><script type="text/javascript" src="paginathing.js" defer></script><script type="text/javascript" src="en-US/bookmarks.js" defer></script><script type="text/javascript" src="en-US/contents.js" defer></script><script type="text/javascript" src="help.js" defer></script><meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body>
<header id="TopLeftHeader"><a class="symbol" href="en-US/text/shared/05/new_help.html"><div></div></a><a class="logo" href="en-US/text/shared/05/new_help.html"><p dir="auto">LibreOffice 24.2 Help</p></a><div class="dropdowns"><div class="modules">
<button type="button" data-a11y-toggle="modules-nav" id="modules" aria-haspopup="true" aria-expanded="false" aria-controls="modules-nav">Module</button><nav id="modules-nav" hidden=""></nav>
</div></div></header><aside class="leftside"><input id="accordion-1" name="accordion-menu" type="checkbox"><label for="accordion-1" dir="auto">Contents</label><div id="Contents" class="contents-treeview"></div></aside><div id="SearchFrame"><div id="Bookmarks">
<input id="search-bar" type="search" class="search" placeholder="Search in bookmarks for all modules" dir="auto"><div class="nav-container" tabindex="0"><nav class="index" dir="auto"></nav></div>
</div></div>
<div id="DisplayArea" itemprop="softwareHelp" itemscope="true" itemtype="http://schema.org/SoftwareApplication">
<a name="bm_id821562797360035"></a>
<meta itemprop="keywords" content="development tools">
<meta itemprop="keywords" content="object inspector">
<a name="bm_id5584892"></a>
<a name="bm_id2672962"></a>
<a name="devtoolsHead"></a>
<h1 id="hd_id951627860296699" dir="auto">
<a name="DevTools_h1"></a>Development Tools</h1>
<p id="par_id3155069" class="paragraph" dir="auto"><a name="DevTools_intro"></a><span class="avis">Inspects objects in LibreOffice documents and shows supported UNO services, as well as available methods, properties and implemented interfaces.</span></p>
<p id="par_id791647281944610" class="paragraph" dir="auto">This feature also allows to explore the document structure using the Document Object Model (DOM).</p>
<a name="howtoget"></a><div class="howtoget">
<div><p class="howtogetheader" dir="auto"><a name="wie"></a>To access this command...</p></div>
<div class="howtogetbody">
<div class="embedded">
<a name="from_menu_bar"></a><h4 id="par_id441684934473786" dir="auto">From the menu bar:</h4>
</div>
<p id="par_id961562795750725" class="paragraph" dir="auto">Choose <span class="menuitem">Tools - Development Tools</span></p>
<div class="embedded">
<a name="from_tabUI"></a><h4 id="par_id711684934483926" dir="auto">From the tabbed interface:</h4>
</div>
<p id="par_id631696591521985" class="paragraph" dir="auto">On the <span class="menuitem">Tools</span> menu of the <span class="menuitem">Tools</span> tab, choose <span class="menuitem">Development Tools</span>.</p>
<div class="embedded">
<a name="from_toolbars"></a><h4 id="par_id101684936253402" dir="auto">From toolbars:</h4>
</div>
<div class="icontable">
<div class="iconcell">
<p id="par_id241637079282587" class="paragraphintable" dir="auto">
<img src="media/icon-themes/cmd/lc_developmenttoolsdockingwindow.svg" class="iconimage" alt="Icon Development Tools" style="width:38px;height:38px" itemprop="icon" itemscope="true" itemtype="http://schema.org/ImageObject">
</p>
</div>
<div class="iconcell">
<p id="par_id991637079282590" class="paragraphintable" dir="auto">Development Tools</p>
</div>
</div>
</div>
</div>
<br>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id271627931218557" dir="auto">The <span class="emph">Development Tools</span> are visible in all documents of LibreOffice Writer, Calc, Impress and Draw. The display is persistent and remain visible until deselected.</p></div>
</div>
<br>
<p id="par_id3152821" class="paragraph" dir="auto">When <span class="emph">Development Tools</span> is enabled, a dockable window is shown at the bottom of the screen. This window has two sections:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id31627862228021" class="listitem" dir="auto"><span class="emph">Document Object Model tree view:</span> Displays document portions according to the Document Object Model (DOM). Use this section to choose the object to inspect.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id581627862228381" class="listitem" dir="auto"><span class="emph">Object inspection panel:</span> Displays the available services, methods, properties and interfaces of the selected object.</p>
</li>
</ul>
<div class="note">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/note.svg" alt="note" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id91627862617231" dir="auto">This feature is available since LibreOffice 7.2 for Writer, Calc, Impress and Draw.</p></div>
</div>
<br>
<h2 id="hd_id791627911297568" dir="auto">Document Model Tree View</h2>
<p id="par_id3153303" class="paragraph" dir="auto">The left side of the window contains a <span class="emph">Current Selection</span> toggle button, a <span class="emph">Refresh</span> button and a tree view that displays all objects in the document.</p>
<p id="par_id891627912224207" class="paragraph" dir="auto">The behavior of the tree view depends on the status of the <span class="emph">Current Selection</span> toggle button:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id811627912238786" class="listitem" dir="auto">Click on <span class="emph">Current Selection</span> to display the properties of the object currently selected in the document. Hence, clicking any item in the tree view have no effect.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id721627912239053" class="listitem" dir="auto">Click on <span class="emph">Current Selection</span> again to display any item in the tree view and update the contents of the <span class="emph">Object Inspection Panel</span>.</p>
</li>
</ul>
<p id="par_id931627912467594" class="paragraph" dir="auto">The types of objects displayed by the <span class="emph">Document Model Tree View</span> depend on the LibreOffice application being used:</p>
<table border="1" class="" cellpadding="0" cellspacing="0">
<tr>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="par_id691627912559559" class="tableheadintable" dir="auto">LibreOffice application</p>
</th>
<th rowspan="" colspan="" class="tableheadcell" dir="auto">
<p id="par_id771627912559559" class="tableheadintable" dir="auto">Supported objects</p>
</th>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id551627912559559" class="tablecontentintable" dir="auto">Writer</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id941627912559559" class="tablecontentintable" dir="auto">Paragraphs<br>Text Portions in a Paragraph<br>Shapes<br>Tables<br>Frames<br>Graphic Objects<br>Embedded Objects (OLE)<br>Style Families and Styles</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id171627912693619" class="tablecontentintable" dir="auto">Calc</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id601627912702265" class="tablecontentintable" dir="auto">Sheets<br>Shapes per sheet<br>Charts per sheet<br>Pivot tables per sheet<br>Style Families and Styles</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id711627912898951" class="tablecontentintable" dir="auto">Impress</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id561627912902324" class="tablecontentintable" dir="auto">Slides<br>Shapes per slide<br>Master slides<br>Style Families and Styles</p>
</td>
</tr>
<tr>
<td rowspan="" colspan="" dir="auto">
<p id="par_id711627912898022" class="tablecontentintable" dir="auto">Draw</p>
</td>
<td rowspan="" colspan="" dir="auto">
<p id="par_id561627912902123" class="tablecontentintable" dir="auto">Pages<br>Shapes per page<br>Style Families and Styles</p>
</td>
</tr>
</table>
<br>
<h2 id="hd_id731627913346236" dir="auto">Object Inspection Panel</h2>
<p id="par_id571627913372273" class="paragraph" dir="auto">The right side of the window is the <span class="emph">Object Inspection Panel</span> that displays information about the object being inspected.</p>
<p id="par_id361627930602108" class="paragraph" dir="auto"><span class="emph">Class Name</span>: is the name of the object class.</p>
<div class="tip">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/tip.svg" alt="tip" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id111627931046662" dir="auto">Use the class name to search more information in the API documentation. For example, the top-level object in a Writer document is an instance of the class <span class="emph">SwXTextDocument</span>, which is documented at <a target="_blank" href="https://docs.libreoffice.org/sw/html/classSwXTextDocument.html">SwXTextDocument Class Reference</a>.</p></div>
</div>
<br>
<p id="par_id371627930700568" class="paragraph" dir="auto">You can inspect the object further by using the four tabs available that display its <span class="emph">Interfaces</span>, <span class="emph">Services</span>, <span class="emph">Properties</span> and <span class="emph">Methods</span>.</p>
<p id="par_id71627913884995" class="paragraph" dir="auto">The information about the object is organized in columns in each tab. The set of columns displayed depend on the selected tab.</p>
<h3 id="hd_id511627914011995" dir="auto">Interfaces tab</h3>
<p id="par_id321627914033147" class="paragraph" dir="auto">Contains a single column presenting the list of interfaces implemented by the object.</p>
<h3 id="hd_id21627913972266" dir="auto">Services tab</h3>
<p id="par_id371627913989665" class="paragraph" dir="auto">Contains a single column presenting the list of services supported by the object.</p>
<h3 id="hd_id901627914056156" dir="auto">Properties tab</h3>
<p id="par_id531627914066770" class="paragraph" dir="auto">Contains four columns that describe the properties of the object:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id461627914264898" class="listitem" dir="auto"><span class="emph">Property</span>: Shows the names of the object properties.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id491627914265327" class="listitem" dir="auto"><span class="emph">Value</span>: Displays a textual representation of the current property value.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id981627914265672" class="listitem" dir="auto"><span class="emph">Type</span>: Shows the property type.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id391627914265992" class="listitem" dir="auto"><span class="emph">Info</span>: display relevant information about the property. For example, a read-only property displays "read-only" in this column.</p>
</li>
</ul>
<div class="tip">
<div class="noteicon" dir="auto"><img src="media/icon-themes/res/helpimg/tip.svg" alt="tip" style="width:40px;height:40px;"></div>
<div class="notetext"><p id="par_id161627914138859" dir="auto">The <span class="emph">Properties</span> tab also includes a text box on the bottom to display the full textual representation of the property value.</p></div>
</div>
<br>
<h3 id="hd_id941627914764723" dir="auto">Methods tab</h3>
<p id="par_id671627914803456" class="paragraph" dir="auto">Contains four columns that describe the combined list of methods that can be called by the current object:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id281627914839271" class="listitem" dir="auto"><span class="emph">Method</span>: Shows the names of all methods of the object.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id421627914839748" class="listitem" dir="auto"><span class="emph">Return type</span>: Displays the return type of the object methods. Methods that do not return any value are marked as "void" in this column.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id891627914840174" class="listitem" dir="auto"><span class="emph">Parameters</span>: Shows the list of parameters that are required by the method as well as their respective types.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id371627914840561" class="listitem" dir="auto"><span class="emph">Implementation class</span>: Displays the name of the class where the method is implemented.</p>
</li>
</ul>
<a name="relatedtopics"></a><div class="relatedtopics">
<p class="related" itemprop="mentions" dir="auto"><a name="related"></a><span class="emph">Related Topics</span>
</p>
<div class="relatedbody" itemprop="mentions">
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="en-US/text/sbasic/shared/uno_objects.html">UNO Objects, Functions and Services</a></p></div>
</div>
</div>
</div>
<div id="DonationFrame"></div>
<footer><div id="DEBUG" class="debug">
<h3 class="bug">Help content debug info:</h3>
<p dir="auto">This page is: <a href="https://opengrok.libreoffice.org/xref/help/source/text/shared/guide/dev_tools.xhp" target="_blank">/text/shared/guide/dev_tools.xhp</a></p>
<p dir="auto">Title is: Development Tools</p>
<p id="bm_module" dir="auto"></p>
<p id="bm_system" dir="auto"></p>
<p id="bm_HID" dir="auto"></p>
</div></footer>
</body>
</html>