# IDisplayFormat

## Content

<div class="docapp-java-api-doc-main"><style>:not(h1, h2, h3, h4, h5, h6)>code,
:not(h1, h2, h3, h4, h5, h6)>tt {
    font-size: 14px;
    padding-top: 4px;
    margin-top: 8px;
    line-height: 1.4em;
}

.summary-table dt code {
    font-size: 14px;
    vertical-align: top;
    padding-top: 4px;
}

.tab {
    background-color: #0066FF;
    color: #ffffff;
    padding: 8px;
    width: 5em;
    font-weight: bold;
}

/*
 * Styles for page header and footer.
 */
.title {
    color: #2c4557;
    margin: 10px 0;
}

.sub-title {
    margin: 5px 0 0 0;
}

.header ul {
    margin: 0 0 15px 0;
    padding: 0;
}

.header ul li,
.footer ul li {
    list-style: none;
}

/*
 * Styles for headings.
 */
.summary h2,
.details h2,
h2,
.block-list h2 {
    padding: 0;
    margin: 15px 0;
}

.summary h3,
.details h3,
.summary .inherited-list h2 {
    background-color: var(--ds-product-color);
    color: #fff;
    border: 1px solid #d0d9e0;
    padding: 7px 5px;
}

.summary h3 a,
.details h3 a,
.summary .inherited-list h2 a {
    color: #fff !important;
}
/*
 * Styles for page layout containers.
 */
dl.notes>dt {
    font-size: 12px;
    font-weight: bold;
    margin: 10px 0 0 0;
    color: #4E4E4E;
}

dl.notes>dd {
    margin: 5px 10px 10px 0;
    font-size: 14px;
}

dl.name-value>dt {
    margin-left: 1px;
    font-size: 1.1em;
    display: inline;
    font-weight: bold;
}

dl.name-value>dd {
    margin: 0 0 0 1px;
    font-size: 1.1em;
    display: inline;
}

/*
 * Styles for lists.
 */
li.circle {
    list-style: circle;
}

ul.horizontal li {
    display: inline;
    font-size: 0.9em;
}

div.inheritance {
    margin: 0;
    padding: 0;
}

div.inheritance div.inheritance {
    margin-left: 2em;
}

ul.block-list,
ul.details-list,
ul.member-list,
ul.summary-list {
    margin: 10px 0 10px 0;
    padding: 0;
}

ul.block-list>li,
ul.details-list>li,
ul.member-list>li,
ul.summary-list>li {
    list-style: none;
    margin-bottom: 15px;
    line-height: 1.4;
}

.summary-table dl,
.summary-table dl dt,
.summary-table dl dd {
    margin-top: 0;
    margin-bottom: 1px;
}

ul.see-list,
ul.see-list-long {
    padding-left: 0;
    list-style: none;
}

ul.see-list li {
    display: inline;
}

ul.see-list li:not(:last-child):after,
ul.see-list-long li:not(:last-child):after {
    content: ", ";
    white-space: pre-wrap;
}

/*
 * Styles for tables.
 */
.summary-table,
.details-table {
    width: 100%;
    border-spacing: 0;
    border-left: 1px solid #EEE;
    border-right: 1px solid #EEE;
    border-bottom: 1px solid #EEE;
    padding: 0;
}

.caption {
    position: relative;
    text-align: left;
    background-repeat: no-repeat;
    color: #253441;
    font-weight: bold;
    clear: none;
    overflow: hidden;
    padding: 0;
    padding-top: 10px;
    padding-left: 1px;
    margin: 0;
    white-space: pre;
}

.caption a:link,
.caption a:visited {
    color: #1f389c;
}

.caption a:hover,
.caption a:active {
    color: #FFFFFF;
}

.caption span {
    white-space: nowrap;
    padding-top: 5px;
    padding-left: 12px;
    padding-right: 12px;
    padding-bottom: 7px;
    display: inline-block;
    background-color: var(--ds-product-color);
    color: #fff;
    border: none;
}

div.table-tabs {
    padding: 10px 0 0 1px;
    margin: 0;
}

div.table-tabs>button {
    border: none;
    cursor: pointer;
    padding: 5px 12px 7px 12px;
    font-weight: bold;
    margin-right: 3px;
}

div.table-tabs>button.active-table-tab {
    background: var(--ds-product-color);
    color: #fff;
}

div.table-tabs>button.table-tab {
    background: var(--ds-product-color);
    color: #FFFFFF;
    border-bottom: 1px solid #eee;
}

.two-column-summary {
    display: grid;
    grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
}

.three-column-summary {
    display: grid;
    grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto);
}

.four-column-summary {
    display: grid;
    grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto);
}

@media screen and (max-width: 600px) {
    .two-column-summary {
        display: grid;
        grid-template-columns: 1fr;
    }
}

@media screen and (max-width: 800px) {
    .three-column-summary {
        display: grid;
        grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
    }

    .three-column-summary .col-last {
        grid-column-end: span 2;
    }
}

@media screen and (max-width: 1000px) {
    .four-column-summary {
        display: grid;
        grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
    }
}

.summary-table>div,
.details-table>div {
    text-align: left;
    padding: 8px 3px 3px 7px;
}

.col-first,
.col-second,
.col-last,
.col-constructor-name,
.col-summary-item-name {
    vertical-align: top;
    padding-right: 0;
    padding-top: 8px;
    padding-bottom: 3px;
}

.table-header {
    background: var(--ds-product-color);
    color: #fff;
    font-weight: bold;
}

.col-first,
.col-first {
    font-size: 13px;
}

.col-second,
.col-second,
.col-last,
.col-constructor-name,
.col-summary-item-name,
.col-last {
    font-size: 13px;
}

.col-first,
.col-second,
.col-constructor-name {
    vertical-align: top;
    overflow: auto;
}

.col-last {
    white-space: normal;
}

.col-first a:link,
.col-first a:visited,
.col-second a:link,
.col-second a:visited,
.col-first a:link,
.col-first a:visited,
.col-second a:link,
.col-second a:visited,
.col-constructor-name a:link,
.col-constructor-name a:visited,
.col-summary-item-name a:link,
.col-summary-item-name a:visited,
.constant-values-container a:link,
.constant-values-container a:visited,
.all-classes-container a:link,
.all-classes-container a:visited,
.all-packages-container a:link,
.all-packages-container a:visited {
    font-weight: bold;
}

.table-sub-heading-color {
    background-color: #EEEEFF;
}

.even-row-color,
.even-row-color .table-header {
    background-color: #FFFFFF;
}

.odd-row-color,
.odd-row-color .table-header {
    background-color: #EEEEEF;
}

/*
 * Styles for contents.
 */
.deprecated-content {
    margin: 0;
    padding: 10px 0;
}

div.block {
    font-size: 14px;
}

.col-last div {
    padding-top: 0;
}

.col-last a {
    padding-bottom: 3px;
}

.module-signature,
.package-signature,
.type-signature,
.member-signature {
    font-size: 14px;
    margin: 14px 0;
    white-space: pre-wrap;
}

.module-signature,
.package-signature,
.type-signature {
    margin-top: 0;
}

.member-signature .type-parameters-long,
.member-signature .parameters,
.member-signature .exceptions {
    display: inline-block;
    vertical-align: top;
    white-space: pre;
}

.member-signature .type-parameters {
    white-space: normal;
}

/*
 * Styles for formatting effect.
 */
.source-line-no {
    color: green;
    padding: 0 30px 0 0;
}

h1.hidden {
    visibility: hidden;
    overflow: hidden;
    font-size: 10px;
}

.block {
    display: block;
    margin: 0 10px 5px 0;
    color: #474747;
}

.deprecated-label,
.descfrm-type-label,
.implementation-label,
.member-name-label,
.member-name-link,
.module-label-in-package,
.module-label-in-type,
.override-specify-label,
.package-label-in-type,
.package-hierarchy-label,
.type-name-label,
.type-name-link,
.search-tag-link,
.preview-label {
    font-weight: bold;
}

.deprecation-block {
    font-size: 14px;
    border-style: solid;
    border-width: thin;
    border-radius: 10px;
    padding: 10px;
    margin-bottom: 10px;
    margin-right: 10px;
    display: inline-block;
}

.preview-block {
    font-size: 14px;
    border-style: solid;
    border-width: thin;
    border-radius: 10px;
    padding: 10px;
    margin-bottom: 10px;
    margin-right: 10px;
    display: inline-block;
}

/*
 * Styles for user-provided tables.
 *
 * borderless:
 *      No borders, vertical margins, styled caption.
 *      This style is provided for use with existing doc comments.
 *      In general, borderless tables should not be used for layout purposes.
 *
 * plain:
 *      Plain borders around table and cells, vertical margins, styled caption.
 *      Best for small tables or for complex tables for tables with cells that span
 *      rows and columns, when the "striped" style does not work well.
 *
 * striped:
 *      Borders around the table and vertical borders between cells, striped rows,
 *      vertical margins, styled caption.
 *      Best for tables that have a header row, and a body containing a series of simple rows.
 */

table.borderless,
table.plain,
table.striped {
    margin-top: 10px;
    margin-bottom: 10px;
}

table.borderless>caption,
table.plain>caption,
table.striped>caption {
    font-weight: bold;
    font-size: smaller;
}

table.borderless th,
table.borderless td,
table.plain th,
table.plain td,
table.striped th,
table.striped td {
    padding: 2px 5px;
}

table.borderless,
table.borderless>thead>tr>th,
table.borderless>tbody>tr>th,
table.borderless>tr>th,
table.borderless>thead>tr>td,
table.borderless>tbody>tr>td,
table.borderless>tr>td {
    border: none;
}

table.borderless>thead>tr,
table.borderless>tbody>tr,
table.borderless>tr {
    background-color: transparent;
}

table.plain {
    border-collapse: collapse;
    border: 1px solid black;
}

table.plain>thead>tr,
table.plain>tbody tr,
table.plain>tr {
    background-color: transparent;
}

table.plain>thead>tr>th,
table.plain>tbody>tr>th,
table.plain>tr>th,
table.plain>thead>tr>td,
table.plain>tbody>tr>td,
table.plain>tr>td {
    border: 1px solid black;
}

table.striped {
    border-collapse: collapse;
    border: 1px solid black;
}

table.striped>thead {
    background-color: #E3E3E3;
}

table.striped>thead>tr>th,
table.striped>thead>tr>td {
    border: 1px solid black;
}

table.striped>tbody>tr:nth-child(even) {
    background-color: #EEE
}

table.striped>tbody>tr:nth-child(odd) {
    background-color: #FFF
}

table.striped>tbody>tr>th,
table.striped>tbody>tr>td {
    border-left: 1px solid black;
    border-right: 1px solid black;
}

table.striped>tbody>tr>th {
    font-weight: normal;
}
</style><h1>Interface IDisplayFormat</h1>
<!-- ======== START OF CLASS DATA ======== -->

<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IDisplayFormat</span></div>
<div class="block">Represents the display settings for an associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a>. <p>Actions such as changing the conditional formatting or table style of a range  can cause what is displayed in the current user interface to be inconsistent with  the values in the corresponding properties of the  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object. Use the properties of this interface to return the values as they are displayed in the  current user interface.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue(1234.56);
 range.setNumberFormat("$#,##0.00");
 range.getBorders().get(BordersIndex.EdgeBottom).setLineStyle(BorderLineStyle.Thin);
 IFormatCondition condition = (IFormatCondition) range.getFormatConditions().add(
     FormatConditionType.CellValue, FormatConditionOperator.Greater, "1000", null);
 condition.setNumberFormat("0.00%");
 condition.getBorders().get(BordersIndex.EdgeBottom).setLineStyle(BorderLineStyle.Thick);
 IDisplayFormat displayFormat = range.getDisplayFormat();
 String numberFormat = displayFormat.getNumberFormat();
 IBorders borders = displayFormat.getBorders();
 </code></pre></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div aria-orientation="horizontal" class="table-tabs" role="tablist"><button aria-controls="method-summary-table.tabpanel" aria-selected="true" class="active-table-tab" id="method-summary-table-tab0" onclick="show('method-summary-table', 'method-summary-table', 3)" onkeydown="switchTab(event)" role="tab" tabindex="0">All Methods</button><button aria-controls="method-summary-table.tabpanel" aria-selected="false" class="table-tab" id="method-summary-table-tab2" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" onkeydown="switchTab(event)" role="tab" tabindex="-1">Instance Methods</button><button aria-controls="method-summary-table.tabpanel" aria-selected="false" class="table-tab" id="method-summary-table-tab3" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" onkeydown="switchTab(event)" role="tab" tabindex="-1">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div aria-labelledby="method-summary-table-tab0" class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getAddIndent()">getAddIndent</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that indicates whether the application automatically indents text  of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> when the text alignment in a cell is set to equal distribution, either horizontally or vertically, as it is displayed in  the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="IBorders.html" title="interface in com.grapecity.documents.excel">IBorders</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getBorders()">getBorders</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a Borders object that represents the borders of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="IFont.html" title="interface in com.grapecity.documents.excel">IFont</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getFont()">getFont</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a Font object that represents the font of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> as it is displayed in the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getFormulaHidden()">getFormulaHidden</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that indicates if the formula of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object is hidden when the worksheet is protected as it is displayed in the current user  interface.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="HorizontalAlignment.html" title="enum class in com.grapecity.documents.excel">HorizontalAlignment</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getHorizontalAlignment()">getHorizontalAlignment</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that represents the horizontal alignment of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getIndentLevel()">getIndentLevel</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that represents the indent level of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="IInterior.html" title="interface in com.grapecity.documents.excel">IInterior</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getInterior()">getInterior</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets an Interior object that represents the interior of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getLocked()">getLocked</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that indicates whether the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> is locked as it is displayed in the current user interface.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getMergeCells()">getMergeCells</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that indicates whether the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object contains merged cells as it is displayed in the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="external-link" href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getNumberFormat()">getNumberFormat</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that represents the format code of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getOrientation()">getOrientation</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that represents the text orientation of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ReadingOrder.html" title="enum class in com.grapecity.documents.excel">ReadingOrder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getReadingOrder()">getReadingOrder</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the reading order of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getShrinkToFit()">getShrinkToFit</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that indicates if the application automatically shrinks text to  fit in the available column width of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="IStyle.html" title="interface in com.grapecity.documents.excel">IStyle</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getStyle()">getStyle</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the  <a href="IStyle.html" title="interface in com.grapecity.documents.excel"><code>IStyle</code></a> object associated with the range.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="VerticalAlignment.html" title="enum class in com.grapecity.documents.excel">VerticalAlignment</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getVerticalAlignment()">getVerticalAlignment</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that represents the vertical alignment of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a class="member-name-link" href="#getWrapText()">getWrapText</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a value that indicates if the application wraps the text of the  associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getAddIndent()">
<h3>getAddIndent</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">getAddIndent</span>()</div>
<div class="block">Gets a value that indicates whether the application automatically indents text  of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> when the text alignment in a cell is set to equal distribution, either horizontally or vertically, as it is displayed in  the current user interface. <p>This property reflects the displayed format of the associated range, which  can differ from the underlying range settings.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setHorizontalAlignment(HorizontalAlignment.Distributed);
 range.setAddIndent(true);
 boolean addIndent = range.getDisplayFormat().getAddIndent();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if text is automatically indented when the text alignment in the cell is set, either horizontally or vertically, to equal distribution;  otherwise,  <code>false</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBorders()">
<h3>getBorders</h3>
<div class="member-signature"><span class="return-type"><a href="IBorders.html" title="interface in com.grapecity.documents.excel">IBorders</a></span>&nbsp;<span class="element-name">getBorders</span>()</div>
<div class="block">Gets a Borders object that represents the borders of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.<p>The returned  <a href="IBorders.html" title="interface in com.grapecity.documents.excel"><code>IBorders</code></a> reflects the displayed border settings of the associated range. These displayed settings can differ from the corresponding  border properties of the range itself when the current appearance is affected  by features such as conditional formatting or table styles. Use  <a href="IRange.html#getDisplayFormat()"><code>IRange.getDisplayFormat()</code></a> to read the border settings as they appear in the user interface.</p>
<pre><code data-language="Java">
 IRange cell = worksheet.getRange("A1");
 cell.setValue(1234.56);
 cell.getBorders().get(BordersIndex.EdgeBottom).setLineStyle(BorderLineStyle.Thin);
 IFormatCondition condition = (IFormatCondition) cell.getFormatConditions().add(
     FormatConditionType.CellValue, FormatConditionOperator.Greater, "1000", null);
 condition.getBorders().get(BordersIndex.EdgeBottom).setLineStyle(BorderLineStyle.Thick);
 IBorders borders = cell.getDisplayFormat().getBorders();
 IBorder bottomBorder = borders.get(BordersIndex.EdgeBottom);
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The <a href="IBorders.html" title="interface in com.grapecity.documents.excel"><code>IBorders</code></a> object that represents the displayed borders of the associated range.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFont()">
<h3>getFont</h3>
<div class="member-signature"><span class="return-type"><a href="IFont.html" title="interface in com.grapecity.documents.excel">IFont</a></span>&nbsp;<span class="element-name">getFont</span>()</div>
<div class="block">Gets a Font object that represents the font of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> as it is displayed in the current user interface. <p>The returned  <a href="IFont.html" title="interface in com.grapecity.documents.excel"><code>IFont</code></a> reflects the displayed font of the associated <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a>. This displayed font can differ from the underlying font  settings of the range when the current appearance is affected by features  such as conditional formatting, table styles, or number formats.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue(1234.56);
 range.getFont().setColor(Color.GetBlack());
 IFormatCondition condition = (IFormatCondition) range.getFormatConditions().add(
     FormatConditionType.CellValue, FormatConditionOperator.Greater, "1000", null);
 condition.getFont().setColor(Color.GetBlue());
 IFont font = range.getDisplayFormat().getFont();
 Color color = font.getColor();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The <a href="IFont.html" title="interface in com.grapecity.documents.excel"><code>IFont</code></a> object that represents the displayed font of the associated range.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFormulaHidden()">
<h3>getFormulaHidden</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">getFormulaHidden</span>()</div>
<div class="block">Gets a value that indicates if the formula of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object is hidden when the worksheet is protected as it is displayed in the current user  interface. <p>This property returns the displayed protection setting for the associated  range. Use  <a href="IRange.html#setFormulaHidden(boolean)"><code>IRange.setFormulaHidden(boolean)</code></a> to hide formulas when the worksheet is protected.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setFormula("=SUM(B1:B2)");
 range.setFormulaHidden(true);
 boolean formulaHidden = range.getDisplayFormat().getFormulaHidden();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the formula is hidden when the worksheet is protected and displayed in the current user interface; otherwise,  <code>false</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getHorizontalAlignment()">
<h3>getHorizontalAlignment</h3>
<div class="member-signature"><span class="return-type"><a href="HorizontalAlignment.html" title="enum class in com.grapecity.documents.excel">HorizontalAlignment</a></span>&nbsp;<span class="element-name">getHorizontalAlignment</span>()</div>
<div class="block">Gets a value that represents the horizontal alignment of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.<p>Use this method to retrieve the effective horizontal alignment shown in the  user interface, which can differ from the corresponding  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> property when conditional formatting or table styles are applied.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setHorizontalAlignment(HorizontalAlignment.Center);
 HorizontalAlignment alignment = range.getDisplayFormat().getHorizontalAlignment();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A <a href="HorizontalAlignment.html" title="enum class in com.grapecity.documents.excel"><code>HorizontalAlignment</code></a> value that indicates the horizontal alignment of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as displayed in the current user interface.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIndentLevel()">
<h3>getIndentLevel</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getIndentLevel</span>()</div>
<div class="block">Gets a value that represents the indent level of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface. <p>Use this method to retrieve the effective indent level shown for the range,  which can differ from the range's own formatting properties when display-affecting  features such as conditional formatting are applied.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setIndentLevel(2);
 int indentLevel = range.getDisplayFormat().getIndentLevel();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The indent level of the associated <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as displayed in the current user interface.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getInterior()">
<h3>getInterior</h3>
<div class="member-signature"><span class="return-type"><a href="IInterior.html" title="interface in com.grapecity.documents.excel">IInterior</a></span>&nbsp;<span class="element-name">getInterior</span>()</div>
<div class="block">Gets an Interior object that represents the interior of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.<p>The returned  <a href="IInterior.html" title="interface in com.grapecity.documents.excel"><code>IInterior</code></a> reflects the displayed fill settings of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a>. These displayed settings can differ from the  corresponding interior properties of the range itself when the current  appearance is affected by features such as conditional formatting or table  styles. Use  <a href="IRange.html#getDisplayFormat()"><code>IRange.getDisplayFormat()</code></a> to read the interior settings as they appear in the user interface.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue(1234.56);
 range.getInterior().setColor(Color.GetYellow());
 IFormatCondition condition = (IFormatCondition) range.getFormatConditions().add(
     FormatConditionType.CellValue, FormatConditionOperator.Greater, "1000", null);
 condition.getInterior().setColor(Color.GetBlue());
 IInterior interior = range.getDisplayFormat().getInterior();
 Color color = interior.getColor();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The <a href="IInterior.html" title="interface in com.grapecity.documents.excel"><code>IInterior</code></a> object that represents the displayed interior of the associated range.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLocked()">
<h3>getLocked</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">getLocked</span>()</div>
<div class="block">Gets a value that indicates whether the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> is locked as it is displayed in the current user interface. <p>This property returns the displayed protection setting for the associated  range.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setLocked(true);
 boolean locked = range.getDisplayFormat().getLocked();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the associated range is locked as displayed in the current user interface; otherwise,  <code>false</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMergeCells()">
<h3>getMergeCells</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">getMergeCells</span>()</div>
<div class="block">Gets a value that indicates whether the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object contains merged cells as it is displayed in the current user interface.
 <pre><code data-language="Java">
 IRange range = worksheet.getRange("A1:B1");
 range.setValue("Test");
 range.merge();
 boolean mergeCells = range.getDisplayFormat().getMergeCells();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the associated <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object contains merged cells; otherwise,  <code>false</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNumberFormat()">
<h3>getNumberFormat</h3>
<div class="member-signature"><span class="return-type"><a class="external-link" href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang">String</a></span>&nbsp;<span class="element-name">getNumberFormat</span>()</div>
<div class="block">Gets a value that represents the format code of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface. <p>Use this method to retrieve the effective number format currently shown for  the range. This displayed format can differ from the range's own format  settings when display-affecting features such as conditional formatting or  table styles are applied.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setNumberFormat("$#,##0.00");
 range.setValue(1234.5);
 String numberFormat = range.getDisplayFormat().getNumberFormat();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The format code of the associated <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as displayed in the current user interface.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getOrientation()">
<h3>getOrientation</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getOrientation</span>()</div>
<div class="block">Gets a value that represents the text orientation of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.<p>The returned value represents the displayed text rotation in degrees.  It follows the same orientation values as  <a href="IRange.html#getOrientation()"><code>IRange.getOrientation()</code></a>,  such as values from -90 to 90, or 255 for vertical text.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setOrientation(45);
 int orientation = range.getDisplayFormat().getOrientation();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The text orientation of the associated <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as displayed in the current user interface.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getReadingOrder()">
<h3>getReadingOrder</h3>
<div class="member-signature"><span class="return-type"><a href="ReadingOrder.html" title="enum class in com.grapecity.documents.excel">ReadingOrder</a></span>&nbsp;<span class="element-name">getReadingOrder</span>()</div>
<div class="block">Gets the reading order of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface. <p>This value reflects the displayed format of the range and can differ from  the corresponding  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> property when the displayed result is affected by formatting such as conditional formatting or table styles.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setReadingOrder(ReadingOrder.RightToLeft);
 ReadingOrder readingOrder = range.getDisplayFormat().getReadingOrder();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The displayed <a href="ReadingOrder.html" title="enum class in com.grapecity.documents.excel"><code>ReadingOrder</code></a> of the associated <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getShrinkToFit()">
<h3>getShrinkToFit</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">getShrinkToFit</span>()</div>
<div class="block">Gets a value that indicates if the application automatically shrinks text to  fit in the available column width of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface. <p>This property reflects the displayed format of the associated range, which  can differ from the underlying range settings.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Long text");
 range.setShrinkToFit(true);
 boolean shrinkToFit = range.getDisplayFormat().getShrinkToFit();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the application automatically shrinks text to fit in the available column width of the associated range as displayed in the  current user interface; otherwise,  <code>false</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStyle()">
<h3>getStyle</h3>
<div class="member-signature"><span class="return-type"><a href="IStyle.html" title="interface in com.grapecity.documents.excel">IStyle</a></span>&nbsp;<span class="element-name">getStyle</span>()</div>
<div class="block">Gets the  <a href="IStyle.html" title="interface in com.grapecity.documents.excel"><code>IStyle</code></a> object associated with the range.<p>The returned style is the range's underlying style object. Display-only  changes introduced by conditional formatting or table styles are not merged  into this style object. To read values as they are currently displayed in the  user interface, use other  <a href="IDisplayFormat.html" title="interface in com.grapecity.documents.excel"><code>IDisplayFormat</code></a> members such as <a href="#getNumberFormat()"><code>getNumberFormat()</code></a>,  <a href="#getFont()"><code>getFont()</code></a>, or  <a href="#getBorders()"><code>getBorders()</code></a>.</p>
<pre><code data-language="Java">
 IStyle currencyStyle = workbook.getStyles().add("CurrencyStyle");
 currencyStyle.setNumberFormat("$#,##0.00");
 IRange range = worksheet.getRange("A1");
 range.setValue(1234.56);
 range.setStyle(currencyStyle);
 IFormatCondition condition = (IFormatCondition) range.getFormatConditions().add(
     FormatConditionType.CellValue, FormatConditionOperator.Greater, "1000", null);
 condition.setNumberFormat("0.00%");
 IStyle style = range.getDisplayFormat().getStyle();
 String baseNumberFormat = style.getNumberFormat();
 String displayedNumberFormat = range.getDisplayFormat().getNumberFormat();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The <a href="IStyle.html" title="interface in com.grapecity.documents.excel"><code>IStyle</code></a> object associated with the range.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVerticalAlignment()">
<h3>getVerticalAlignment</h3>
<div class="member-signature"><span class="return-type"><a href="VerticalAlignment.html" title="enum class in com.grapecity.documents.excel">VerticalAlignment</a></span>&nbsp;<span class="element-name">getVerticalAlignment</span>()</div>
<div class="block">Gets a value that represents the vertical alignment of the associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.<p>Use this property to retrieve the effective vertical alignment shown for the  range, which can differ from the corresponding range property when display  settings are affected by features such as conditional formatting or table  styles.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setVerticalAlignment(VerticalAlignment.Center);
 VerticalAlignment alignment = range.getDisplayFormat().getVerticalAlignment();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The displayed vertical alignment of the associated range.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getWrapText()">
<h3>getWrapText</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">getWrapText</span>()</div>
<div class="block">Gets a value that indicates if the application wraps the text of the  associated  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> object as it is displayed in the current user interface.<p>This property reflects the displayed format of the associated range, which  can differ from the underlying  <a href="IRange.html" title="interface in com.grapecity.documents.excel"><code>IRange</code></a> settings.</p>
<pre><code data-language="Java">
 IRange range = worksheet.getRange("A1");
 range.setValue("Test");
 range.setWrapText(true);
 boolean wrapText = range.getDisplayFormat().getWrapText();
 </code></pre></div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the application wraps the text of the associated range as displayed in the current user interface; otherwise,  <code>false</code>.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
<script>var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";

function show(tableId, selected, columns) {
    if (tableId !== selected) {
        document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')')
            .forEach(function (elem) {
                elem.style.display = 'none';
            });
    }
    document.querySelectorAll('div.' + selected)
        .forEach(function (elem, index) {
            elem.style.display = '';
            var isEvenRow = index % (columns * 2) < columns;
            elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor);
            elem.classList.add(isEvenRow ? evenRowColor : oddRowColor);
        });
    updateTabs(tableId, selected);
}

function updateTabs(tableId, selected) {
    document.querySelector('div#' + tableId + ' .summary-table')
        .setAttribute('aria-labelledby', selected);
    document.querySelectorAll('button[id^="' + tableId + '"]')
        .forEach(function (tab, index) {
            if (selected === tab.id || (tableId === selected && index === 0)) {
                tab.className = activeTableTab;
                tab.setAttribute('aria-selected', true);
                tab.setAttribute('tabindex', 0);
            } else {
                tab.className = tableTab;
                tab.setAttribute('aria-selected', false);
                tab.setAttribute('tabindex', -1);
            }
        });
}

function switchTab(e) {
    var selected = document.querySelector('[aria-selected=true]');
    if (selected) {
        if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) {
            // left or up arrow key pressed: move focus to previous tab
            selected.previousSibling.click();
            selected.previousSibling.focus();
            e.preventDefault();
        } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) {
            // right or down arrow key pressed: move focus to next tab
            selected.nextSibling.click();
            selected.nextSibling.focus();
            e.preventDefault();
        }
    }
}
</script></div>