Automate Presentation Localization in PHP

What this page is about

Set proofing languages for PowerPoint and OpenDocument presentation text in PHP with Aspose.Slides, including defaults and multilingual paragraphs.

Overview

Aspose.Slides for PHP via Java lets you configure proofing metadata for individual text portions. Use BasePortionFormat::setLanguageId to identify the proofing language, BasePortionFormat::setSpellCheck to allow or suppress spelling checks, and BasePortionFormat::setProofDisabled to control the broader no-proof state. Because these settings are applied at the portion level, one paragraph can contain multiple languages and different proofing rules.

This article explains how to assign a language to specific text, set the default language for new text with LoadOptions::setDefaultTextLanguage, build multilingual paragraphs, choose between SpellCheck and ProofDisabled, and preserve the intended settings when using Presentation::joinPortionsWithSameFormatting. These properties store metadata for presentation applications; they do not translate text, perform dictionary-based spell checking, or return misspelled words.

Set the Proofing Language for Text

Create or load a Presentation, access the required text portion through Portion::getPortionFormat, and assign its language identifier. The following example creates a shape, sets British English as the proofing language, and saves the result with Presentation::save:

use aspose\slides\Presentation;
use aspose\slides\SaveFormat;
use aspose\slides\ShapeType;

$presentation = new Presentation();
try {
    $slide = $presentation->getSlides()->get_Item(0);
    $shape = $slide->getShapes()->addAutoShape(ShapeType::Rectangle, 50, 50, 320, 80);
    $shape->getTextFrame()->setText("Set the proofing language for this text.");

    $portion = $shape->getTextFrame()->getParagraphs()->get_Item(0)->getPortions()->get_Item(0);
    $portion->getPortionFormat()->setLanguageId("en-GB");

    $presentation->save("proofing_language.pptx", SaveFormat::Pptx);
} finally {
    $presentation->dispose();
}

Set the Default Language for New Text

Use LoadOptions::setDefaultTextLanguage to specify the proofing language that Aspose.Slides assigns to newly created text. This setting is useful when most or all new text in a presentation uses the same language. It does not change the language metadata of text that already has an explicit language.

The following example creates a presentation whose new text uses German proofing rules:

use aspose\slides\LoadOptions;
use aspose\slides\Presentation;
use aspose\slides\SaveFormat;
use aspose\slides\ShapeType;

$loadOptions = new LoadOptions();
$loadOptions->setDefaultTextLanguage("de-DE");

$presentation = new Presentation($loadOptions);
try {
    $slide = $presentation->getSlides()->get_Item(0);
    $shape = $slide->getShapes()->addAutoShape(ShapeType::Rectangle, 50, 50, 320, 80);
    $shape->getTextFrame()->setText("Willkommen zur Präsentation");

    $presentation->save("default_text_language.pptx", SaveFormat::Pptx);
} finally {
    $presentation->dispose();
}

Use Multiple Languages in One Paragraph

A Paragraph contains a collection of text portions. Create a separate Portion for each language and set its LanguageId independently.

This example creates one paragraph with English and French portions:

use aspose\slides\Portion;
use aspose\slides\Presentation;
use aspose\slides\SaveFormat;
use aspose\slides\ShapeType;

$presentation = new Presentation();
try {
    $slide = $presentation->getSlides()->get_Item(0);
    $shape = $slide->getShapes()->addAutoShape(ShapeType::Rectangle, 50, 50, 420, 80);
    $paragraph = $shape->getTextFrame()->getParagraphs()->get_Item(0);
    $paragraph->getPortions()->clear();

    $englishPortion = new Portion("Welcome");
    $englishPortion->getPortionFormat()->setLanguageId("en-US");
    $paragraph->getPortions()->add($englishPortion);

    $frenchPortion = new Portion(" — Bienvenue");
    $frenchPortion->getPortionFormat()->setLanguageId("fr-FR");
    $paragraph->getPortions()->add($frenchPortion);

    $presentation->save("multilingual_text.pptx", SaveFormat::Pptx);
} finally {
    $presentation->dispose();
}

Enable or Suppress Spell Checking for Individual Portions

PortionFormat inherits the common text properties defined by BasePortionFormat. Access a portion’s format through Portion::getPortionFormat and use BasePortionFormat::setSpellCheck to control whether a presentation application may check spelling for that portion. The default value is false: true allows spell checking, while false suppresses it.

The setting applies to individual text portions. Different portions in the same paragraph can therefore use different values. BasePortionFormat::setLanguageId and setSpellCheck serve complementary purposes: setLanguageId identifies the proofing language, while setSpellCheck determines whether spelling checks are allowed for the portion.

BasePortionFormat::setProofDisabled also controls proofing, but it represents the broader “do not proof” state as a NullableBool. Use setSpellCheck when you need a direct Boolean switch specifically for spelling checks. Use setProofDisabled when you need to preserve or explicitly control the presentation’s no-proof metadata, including its NotDefined state. If you set both properties, keep their values consistent; do not combine setSpellCheck(true) with setProofDisabled(NullableBool::True).

These properties configure proofing metadata used by PowerPoint and other presentation applications. Aspose.Slides does not use them to run dictionary-based spell checking or return a list of misspelled words.

The following complete example creates an input presentation, loads it, assigns different spell-check settings and proofing languages to two portions in the same paragraph, saves the result, reopens it, and verifies the stored values:

use aspose\slides\Portion;
use aspose\slides\Presentation;
use aspose\slides\SaveFormat;
use aspose\slides\ShapeType;

$inputFile = "spell_check_input.pptx";
$outputFile = "spell_check_settings.pptx";

$sourcePresentation = new Presentation();
try {
    $sourceSlide = $sourcePresentation->getSlides()->get_Item(0);
    $sourceShape = $sourceSlide->getShapes()->addAutoShape(ShapeType::Rectangle, 50, 50, 420, 80);
    $sourceParagraph = $sourceShape->getTextFrame()->getParagraphs()->get_Item(0);
    $sourceParagraph->getPortions()->clear();

    $sourceEnglishPortion = new Portion("Check this text. ");
    $sourceEnglishPortion->getPortionFormat()->setLanguageId("en-US");
    $sourceParagraph->getPortions()->add($sourceEnglishPortion);

    $sourceFrenchPortion = new Portion("Ignorer ce code : ZX-81.");
    $sourceFrenchPortion->getPortionFormat()->setLanguageId("fr-FR");
    $sourceParagraph->getPortions()->add($sourceFrenchPortion);

    $sourcePresentation->save($inputFile, SaveFormat::Pptx);
} finally {
    $sourcePresentation->dispose();
}

$presentation = new Presentation($inputFile);
try {
    $shape = $presentation->getSlides()->get_Item(0)->getShapes()->get_Item(0);
    $portions = $shape->getTextFrame()->getParagraphs()->get_Item(0)->getPortions();

    $checkedPortion = $portions->get_Item(0);
    $checkedPortion->getPortionFormat()->setLanguageId("en-US");
    $checkedPortion->getPortionFormat()->setSpellCheck(true);

    $suppressedPortion = $portions->get_Item(1);
    $suppressedPortion->getPortionFormat()->setLanguageId("fr-FR");
    $suppressedPortion->getPortionFormat()->setSpellCheck(false);

    $presentation->save($outputFile, SaveFormat::Pptx);
} finally {
    $presentation->dispose();
}

$reopenedPresentation = new Presentation($outputFile);
try {
    $reopenedShape = $reopenedPresentation->getSlides()->get_Item(0)->getShapes()->get_Item(0);
    $storedPortions = $reopenedShape->getTextFrame()->getParagraphs()->get_Item(0)->getPortions();

    $storedPortionCount = java_values($storedPortions->getCount());
    $firstStoredFormat = $storedPortions->get_Item(0)->getPortionFormat();
    $secondStoredFormat = $storedPortions->get_Item(1)->getPortionFormat();

    $firstPortionStored = $storedPortionCount === 2 && 
        java_values($firstStoredFormat->getLanguageId()) === "en-US" && 
        java_values($firstStoredFormat->getSpellCheck());

    $secondPortionStored = $storedPortionCount === 2 && 
        java_values($secondStoredFormat->getLanguageId()) === "fr-FR" && 
        !java_values($secondStoredFormat->getSpellCheck());

    if ($firstPortionStored && $secondPortionStored) {
        echo "The proofing settings were stored correctly.";
    } else {
        echo "The proofing settings could not be verified.";
    }
} finally {
    $reopenedPresentation->dispose();
}

Presentation::joinPortionsWithSameFormatting combines adjacent portions that have the same formatting. A difference in SpellCheck alone does not keep such portions separate; after they are joined, the resulting portion retains the SpellCheck value of the first portion. If portions need different spell-check settings, call joinPortionsWithSameFormatting before assigning those settings, or inspect the resulting portion boundaries and reapply the settings afterward. Portions with different LanguageId values remain separate because their proofing-language formatting differs.

FAQ

Does a language ID translate the text?

No. BasePortionFormat::setLanguageId stores proofing metadata for spelling and grammar; it does not alter the text content. Translate the text separately, and then set the appropriate language identifier for each translated portion.

Does the proofing language control fonts, hyphenation, or line wrapping?

No. The language identifier is for proofing. Text rendering and layout primarily depend on the available fonts, the writing system, and the text-frame settings. For reliable rendering, provide the required fonts, configure font substitution, or embed fonts in the presentation.

Can one paragraph use several proofing languages?

Yes. Assign each language to a separate portion, as shown in the multilingual paragraph example.

Should I use setDefaultTextLanguage or setLanguageId?

Use LoadOptions::setDefaultTextLanguage when you want a default for newly created text. Use BasePortionFormat::setLanguageId when a specific portion needs an explicit proofing language or when a paragraph contains multiple languages.

Advanced Text Extraction from Presentations in PHP Create and Apply WordArt Effects in PHP